Skip to main content

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',
]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autodoc-traits-0.1.0.tar.gz (3.4 kB view hashes)

Uploaded Source

Built Distribution

autodoc_traits-0.1.0-py3-none-any.whl (3.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page