Autodoc extention for documenting traits
Project description
Trait-Documenter is an autodoc extension to allow trait definitions to be properly rendered in sphinx.
Installation
Development versions can be found at https://github.com/enthought/trait-documenter.
The package requires a recent version of sphinx, traits and astor to function properly.
Usage
Add the trait-documenter to the extensions variable in your conf.py:
extensions.append('trait_documenter')
Example
A class trait with a docstring:
from traits.api import HasTraits, Float
class MyClass(HasTraits):
#: A float number.
number = Float(2.0)
Will be rendered as:
.. py:attribute:: number :annotation: = Float(2.0) A float number.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
trait_documenter-1.1.0.zip
(24.9 kB
view hashes)
trait_documenter-1.1.0.tar.gz
(15.6 kB
view hashes)
trait_documenter-1.1.0.tar.bz2
(14.5 kB
view hashes)
