Sphinx extension to autodoc traitlets
Project description
autodoc-traits
Sphinx extension to autodocument configuration files using the traitlets library
Install
python3 -m pip install autodoc-traits
Usage
Add autodoc_traits to the extensions list in
a Sphinx conf.py file:
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'autodoc_traits',
'sphinx_copybutton',
]
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file autodoc-traits-0.1.0.dev0.tar.gz.
File metadata
- Download URL: autodoc-traits-0.1.0.dev0.tar.gz
- Upload date:
- Size: 3.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 340c0fca8ced0f363dd36d1b13689052f350a590fc27a5ad6a54dccf78698b76 |
|
| MD5 | 41a599ed4ed7df5f8854680af4cc5ce5 |
|
| BLAKE2b-256 | dcb9d9f20bb6bb0f760cf0691a557b1156688cc7e9eff90aff118a9ef35fd5e4 |
Provenance
File details
Details for the file autodoc_traits-0.1.0.dev0-py3-none-any.whl.
File metadata
- Download URL: autodoc_traits-0.1.0.dev0-py3-none-any.whl
- Upload date:
- Size: 3.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a6ace32c9bc78d44f4623b69f844d6335dedf3a0b38e7401f02a1c611dd58893 |
|
| MD5 | 2e4a175a5f2b34615f48ecf0ab5ccf9e |
|
| BLAKE2b-256 | f4db5daa43d8dd0254e60f49beebfe092c1a309c08064ed9b0a287e26666fb80 |
