Sphinx-autox
A little opinionated version of autodoc and autosummary that recursively documents your modules and creates one file per class.
Usage
Add sphinxext_autox as the first entry to your extensions in conf.py:
extensions = [
'sphinxext_autox',
...
]
Create a api.rst file like the following:
My API
======
.. autosummary::
:toctree: source
:recursive:
mymodule1
mymodule2
The stub files will be created/maintained in the source folder.
Critique
Unfortunately, since other files in Sphinx also try to load autodoc, this package has to replace the original files. It isn't possible to make a custom version without also having to change the rST tags.
Metadata
Release files for sphinxext-autox 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxext_autox-0.0.2.tar.gz | 50.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxext_autox-0.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 107.6 kB
Release files / sphinxext_autox-0.0.2.tar.gz
| Download URL | sphinxext_autox-0.0.2.tar.gz |
|---|---|
| Size | 50.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a25a984de779d8afca488406f4442da9911e2dac8ceec6ed2c4bd97020788c42
|
|
BLAKE2b-256 checksum How to use checksums |
12aeb0be687bc51b6f5dffa0e954b847206738d350f23384220cbe92bbc31023
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.23.0 setuptools/52.0.0.post20210125 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.8.5
|
Release files / sphinxext_autox-0.0.2-py3-none-any.whl
| Download URL | sphinxext_autox-0.0.2-py3-none-any.whl |
|---|---|
| Size | 57.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6d80f9ce2447546094578f39c5e6f58501c51061872d79c47d2c986a9cfe2a76
|
|
BLAKE2b-256 checksum How to use checksums |
83378b9a470e9387400aa354ec46fe25d3d28d306e60c8406ba5a648e05b9ad7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.23.0 setuptools/52.0.0.post20210125 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.8.5
|