Skip to content

Commit 7e0e618

Browse files
committed
Add license info to the docs.
1 parent e39d5d8 commit 7e0e618

File tree

5 files changed

+17
-0
lines changed

5 files changed

+17
-0
lines changed

doc-source/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,7 @@ This avoids having to manually compile (and keep updated) a mapping like:
173173
.. _core metadata: https://packaging.python.org/specifications/core-metadata
174174
.. _pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests
175175

176+
176177
Contents
177178
--------
178179

@@ -189,6 +190,7 @@ Contents
189190
usage
190191
api/index
191192
Source
193+
license
192194

193195
.. sidebar-links::
194196
:caption: Links

doc-source/license.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
=========
2+
License
3+
=========
4+
5+
``seed_intersphinx_mapping`` is licensed under the :choosealicense:`MIT`
6+
7+
.. license-info:: MIT
8+
9+
.. license::
10+
:py: seed_intersphinx_mapping

doc-source/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ furo>=2020.11.19b18
55
seed-intersphinx-mapping>=0.3.1
66
sphinx-copybutton>=0.2.12
77
sphinx-debuginfo>=0.1.0
8+
sphinx-licenseinfo>=0.1.1
89
sphinx-notfound-page>=0.5
910
sphinx-prompt>=1.1.0
1011
sphinx-pyproject>=0.1.0

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ extensions = [
7070
"sphinxcontrib.default_values",
7171
"sphinxcontrib.toctree_plus",
7272
"sphinx_debuginfo",
73+
"sphinx_licenseinfo",
7374
"seed_intersphinx_mapping",
7475
"sphinx_toolbox_experimental.html_section",
7576
"sphinx_toolbox_experimental.autosummary_widths",

tox.ini

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,9 @@ rst-directives =
126126
TODO
127127
envvar
128128
extras-require
129+
license
130+
license-info
131+
rst-roles = choosealicense
129132
per-file-ignores =
130133
tests/*: D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000 SLOT000 SLOT001 SLOT002
131134
*/*.pyi: E301 E302 E305 D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000 SLOT000 SLOT001 SLOT002

0 commit comments

Comments
 (0)