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 details)
trait_documenter-1.1.0.tar.gz
(15.6 kB
view details)
trait_documenter-1.1.0.tar.bz2
(14.5 kB
view details)
File details
Details for the file trait_documenter-1.1.0.zip.
File metadata
- Download URL: trait_documenter-1.1.0.zip
- Upload date:
- Size: 24.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 49b97598973e8182c4135df81b28214642ed7725bb0b2e45eb063f22aa6ed88f |
|
| MD5 | 99adc14101c4ebc940ba49c29fc9b2b7 |
|
| BLAKE2b-256 | 8fa8001b1557fab1a172d4f1c2bc9f73deb424f490160aa0c588101124f01987 |
File details
Details for the file trait_documenter-1.1.0.tar.gz.
File metadata
- Download URL: trait_documenter-1.1.0.tar.gz
- Upload date:
- Size: 15.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 123cb703a6cf166b4a32e8654fad16855820fdc7705c4f23be6b3b2ea8aa6229 |
|
| MD5 | 34419692e2d5d0aa911092e0d2354e96 |
|
| BLAKE2b-256 | 471afa96639da8c558652630d2cfef4d643db59839344d817710920bbf059774 |
File details
Details for the file trait_documenter-1.1.0.tar.bz2.
File metadata
- Download URL: trait_documenter-1.1.0.tar.bz2
- Upload date:
- Size: 14.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d3827c647eb584cd9d421b3dfb3669593787475b40cfad44e7ea13c91cf5261d |
|
| MD5 | f860020b38c4b762660c9b01b2e144e2 |
|
| BLAKE2b-256 | e6946fefdd7d70ca903a88ee2f77f0f0a9aadf3ab24b51bce97a02e7320c27ed |
