Skip to content

Commit c361686

Browse files
committed
Add license information to the docs.
1 parent f447fc1 commit c361686

File tree

5 files changed

+18
-2
lines changed

5 files changed

+18
-2
lines changed

doc-source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ Installation
124124

125125
.. end installation
126126
127+
127128
.. toctree::
128129
:hidden:
129130

@@ -138,7 +139,7 @@ Installation
138139
configuration
139140
changelog
140141
Source
141-
142+
license
142143

143144
.. toctree::
144145
:maxdepth: 3
@@ -148,7 +149,6 @@ Installation
148149
api/snippet-fmt
149150
api/*
150151

151-
152152
.. sidebar-links::
153153
:github:
154154
:pypi: snippet-fmt

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+
``snippet-fmt`` is licensed under the :choosealicense:`MIT`
6+
7+
.. license-info:: MIT
8+
9+
.. license::
10+
:py: snippet-fmt

doc-source/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ seed-intersphinx-mapping>=0.3.1
88
sphinx>=3.0.3
99
sphinx-copybutton>=0.2.12
1010
sphinx-debuginfo>=0.1.0
11+
sphinx-licenseinfo>=0.1.1
1112
sphinx-notfound-page>=0.5
1213
sphinx-prompt>=1.1.0
1314
sphinx-pyproject>=0.1.0

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ extensions = [
6161
"sphinxcontrib.default_values",
6262
"sphinxcontrib.toctree_plus",
6363
"sphinx_debuginfo",
64+
"sphinx_licenseinfo",
6465
"seed_intersphinx_mapping",
6566
"attr_utils.autoattrs",
6667
"sphinx_click",

tox.ini

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ deps =
8484
flake8-dunder-all>=0.1.1
8585
flake8-encodings>=0.1.0
8686
flake8-github-actions>=0.1.0
87+
flake8-noqa>=1.1.0
8788
flake8-pyi>=20.10.0
8889
flake8-pytest-style>=1.3.0
8990
flake8-slots>=0.1.0
@@ -141,6 +142,9 @@ rst-directives =
141142
TODO
142143
envvar
143144
extras-require
145+
license
146+
license-info
147+
rst-roles = choosealicense
144148
per-file-ignores =
145149
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
146150
*/*.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)