Skip to content

Commit 258f10d

Browse files
committed
Update licensing/docs in code headers project-wide
Add CC BY 4.0, bit more detail. Switch to point to the stable build on RtD.
1 parent 5bffe8f commit 258f10d

34 files changed

+206
-66
lines changed

conftest.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
http://www.github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
http://sphobjinv.readthedocs.io
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

doc/source/conf.py

+6
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,12 @@
122122
123123
.. _license_txt: https://github.com/bskinn/sphobjinv/blob/main/LICENSE.txt
124124
125+
.. _MIT License: https://opensource.org/licenses/MIT
126+
127+
.. |CC BY 4.0| replace:: CC BY 4.0 International License
128+
129+
.. _CC BY 4.0: http://creativecommons.org/licenses/by/4.0/
130+
125131
.. |fuzzywuzzy| replace:: ``fuzzywuzzy``
126132
127133
.. _fuzzywuzzy: https://github.com/seatgeek/fuzzywuzzy

src/sphobjinv/__init__.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/__main__.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/_vendored/__init__.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,14 @@
1818
https://github.com/bskinn/sphobjinv
1919
2020
**Documentation**
21-
https://sphobjinv.readthedocs.io/en/latest
21+
https://sphobjinv.readthedocs.io/en/stable
2222
2323
**License**
24-
The MIT License; see |license_txt|_ for full license terms
24+
Code: `MIT License`_
25+
26+
Docs & Docstrings: |CC BY 4.0|_
27+
28+
See |license_txt|_ for full license terms.
2529
2630
**Members**
2731

src/sphobjinv/_vendored/fuzzywuzzy/__init__.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,14 @@
3131
https://github.com/bskinn/sphobjinv
3232
3333
**Documentation**
34-
https://sphobjinv.readthedocs.io/en/latest
34+
https://sphobjinv.readthedocs.io/en/stable
3535
3636
**License**
37-
The MIT License; see |license_txt|_ for full license terms
37+
Code: `MIT License`_
38+
39+
Docs & Docstrings: |CC BY 4.0|_
40+
41+
See |license_txt|_ for full license terms.
3842
3943
**Members**
4044

src/sphobjinv/cli/__init__.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/cli/convert.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/cli/core.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/cli/load.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/cli/parser.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/cli/paths.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/cli/suggest.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/cli/ui.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/cli/write.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/data.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/enum.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/error.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/fileops.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/inventory.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/re.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

src/sphobjinv/schema.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,14 @@
1717
https://github.com/bskinn/sphobjinv
1818
1919
**Documentation**
20-
https://sphobjinv.readthedocs.io/en/latest
20+
https://sphobjinv.readthedocs.io/en/stable
2121
2222
**License**
23-
The MIT License; see |license_txt|_ for full license terms
23+
Code: `MIT License`_
24+
25+
Docs & Docstrings: |CC BY 4.0|_
26+
27+
See |license_txt|_ for full license terms.
2428
2529
**Members**
2630

src/sphobjinv/version.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@
1616
https://github.com/bskinn/sphobjinv
1717
1818
**Documentation**
19-
https://sphobjinv.readthedocs.io/en/latest
19+
https://sphobjinv.readthedocs.io/en/stable
2020
2121
**License**
22-
The MIT License; see |license_txt|_ for full license terms
22+
Code: `MIT License`_
23+
24+
Docs & Docstrings: |CC BY 4.0|_
25+
26+
See |license_txt|_ for full license terms.
2327
2428
**Members**
2529

0 commit comments

Comments
 (0)