Skip to content

rkdarst/autodoc-traits

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

Sphinx extension to autodocument traitlets

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%