This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

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')

Warning

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

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 History

Release History

This version
History Node

1.1.0

History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
trait_documenter-1.1.0.tar.bz2 (14.5 kB) Copy SHA256 Checksum SHA256 Source Nov 9, 2016
trait_documenter-1.1.0.tar.gz (15.6 kB) Copy SHA256 Checksum SHA256 Source Nov 9, 2016
trait_documenter-1.1.0.zip (24.9 kB) Copy SHA256 Checksum SHA256 Source Nov 9, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting