sphinxcontrib-autofile
A sphinx extension to generate module for many files from a glob expression.
Usage
Take MyST as an example. rst is similar.
docs/conf.py:
# ...
extensions = [
"myst_parser",
"sphinxcontrib.autofile",
]
# ...
docs/index.md:
```{autofile} ../src/sphinxcontrib/autofile/*.py
:members:
```
It will be translated to
```{eval-rst}
.. automodule:: sphinxcontrib.autofile
:members:
.. automodule:: sphinxcontrib.autofile.directive
:members:
... (more modules)
```
When your modules is too many, it will save your time.
Customize
```{autofile} ../src/sphinxcontrib/autofile/*.py
:prefix: your_prefix
:template: /the/path/of/your/template
```
prefix: If you don't use src-layout, change it.template: template use jinja syntax. See examples.
Alternatives
See
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-autofile 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 | |
|---|---|---|---|
| sphinxcontrib-autofile-0.0.2.tar.gz | 24.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_autofile-0.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 42.2 kB
Release files / sphinxcontrib-autofile-0.0.2.tar.gz
| Download URL | sphinxcontrib-autofile-0.0.2.tar.gz |
|---|---|
| Size | 24.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5ac1b17f04b86106ec2c524c9e511ec746754c6bcdf50c2a82e2268b5f20e864
|
|
BLAKE2b-256 checksum How to use checksums |
94a08109bb97dcd8fea9fc4aa51ac05b632e18da2883f225ef0978a5d9fa373b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.5
|
Release files / sphinxcontrib_autofile-0.0.2-py3-none-any.whl
| Download URL | sphinxcontrib_autofile-0.0.2-py3-none-any.whl |
|---|---|
| Size | 18.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b5d3df354080de635e41f57247829b01097be74e44f4fcd0ebe0f9b3a981a00f
|
|
BLAKE2b-256 checksum How to use checksums |
adaa78c2b3b06687d4af800fd280b2a21cef358773c672b45378b751b557bf44
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.5
|
