Trait-Documenter
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.
Release files for trait_documenter 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distributions (sdists)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| trait_documenter-1.1.0.zip | 24.9 kB | Without provenance | Details for trait_documenter-1.1.0.zip | |
| trait_documenter-1.1.0.tar.gz | 15.6 kB | Without provenance | Details for trait_documenter-1.1.0.tar.gz | |
| trait_documenter-1.1.0.tar.bz2 | 14.5 kB | Without provenance | Details for trait_documenter-1.1.0.tar.bz2 |
Release files / trait_documenter-1.1.0.zip
| Download URL | trait_documenter-1.1.0.zip |
|---|---|
| Size | 24.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
49b97598973e8182c4135df81b28214642ed7725bb0b2e45eb063f22aa6ed88f
|
|
BLAKE2b-256 checksum How to use checksums |
8fa8001b1557fab1a172d4f1c2bc9f73deb424f490160aa0c588101124f01987
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / trait_documenter-1.1.0.tar.gz
| Download URL | trait_documenter-1.1.0.tar.gz |
|---|---|
| Size | 15.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
123cb703a6cf166b4a32e8654fad16855820fdc7705c4f23be6b3b2ea8aa6229
|
|
BLAKE2b-256 checksum How to use checksums |
471afa96639da8c558652630d2cfef4d643db59839344d817710920bbf059774
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / trait_documenter-1.1.0.tar.bz2
| Download URL | trait_documenter-1.1.0.tar.bz2 |
|---|---|
| Size | 14.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d3827c647eb584cd9d421b3dfb3669593787475b40cfad44e7ea13c91cf5261d
|
|
BLAKE2b-256 checksum How to use checksums |
e6946fefdd7d70ca903a88ee2f77f0f0a9aadf3ab24b51bce97a02e7320c27ed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for trait_documenter 1.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
