Skip to content

itziakos/trait-documenter

 
 

Repository files navigation

Trait-Documenter

image

image

Trait-Documenter is an autodoc extension to allow trait definitions to be properly rendered in sphinx.

Installation

The package requires sphinx and traits to function properly.

Usage

Add the trait-documenter to the extensions variable in your conf.py:

extensions.append('trait_documenter')

Warning

Using the TraitDocumenter in conjunction with the TraitsDoc package is not advised.

About

A sphinx extention that allows traits attributes to be properly rendered by autodoc

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%