Skip to content

Commit b3a59c5

Browse files
committed
Publish to PyPI
1 parent 18dc5f8 commit b3a59c5

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,14 @@ def setup(app: Sphinx) -> None:
2929

3030
Refer to the [published sample](https://github.com/hunyadi/sphinx_doc/blob/master/doc/conf.py) for a more detailed example how to use this extension with Sphinx.
3131

32+
## Installation
33+
34+
This package is [published to PyPI](https://pypi.org/project/python-sphinx-doc/).
35+
36+
```sh
37+
pip install --upgrade python-sphinx-doc
38+
```
39+
3240
## Motivation
3341

3442
To pass type information to `autodoc`, you would normally be required to use the [info field list](https://www.sphinx-doc.org/en/master/usage/domains/python.html#info-field-lists) items `:param:` and/or `:type:` with explicit type specification:

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ long_description = file: README.md
88
long_description_content_type = text/markdown
99
license = MIT
1010
classifiers =
11-
Development Status :: 5 - Production
11+
Development Status :: 5 - Production/Stable
1212
Environment :: Console
1313
Intended Audience :: Developers
1414
Intended Audience :: End Users/Desktop

0 commit comments

Comments
 (0)