sphinx-autodoc-construct
A Sphinx extension to automatically document your Contruct structs.
Installation
pip3 install sphinx-autodoc-construct
Configuration
# conf.py
extensions = {
'...',
'sphinx_autodoc_construct'
}
Usage
.. automodcon:: my_package.my_module
.. autostruct:: my_package.my_module.my_struct
.. automodcon:: documents all structs found in a module and .. autostruct:: documents a specific struct.
And here's the cool part, once a struct is covered by .. automodcon:: or .. autostruct::, you can link to it in your rst
:any:`link<my_struct>` is displayed as a hyperlink.
:ref:`mystruct<my_struct>` is displayed as a reference.
References can even be used in your commented struct fields
from construct import *
my_struct = Struct(
'id': Int32ul,
'otherId': Int32ul * "index refering to :ref:`other_struct`",
)
1 maintainer
Metadata
1 maintainer
Release files for sphinx-autodoc-construct 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx-autodoc-construct-0.1.0.tar.gz | 8.2 kB | Details |
Release files / sphinx-autodoc-construct-0.1.0.tar.gz
| Download URL | sphinx-autodoc-construct-0.1.0.tar.gz |
|---|---|
| Size | 8.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3ba497ca7c141f13118d0215d0e1057a546ad867e7c0db45fea825e55080d52a
|
|
BLAKE2b-256 checksum How to use checksums |
d35a827c7fc580a4a60e3b6feaa45bed9d4487cd0d3f54af530aadd20e5e1568
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.8.10
|
