Metadata-Version: 1.1
Name: trait-documenter
Version: 1.0.0
Summary: Autodoc extention for documenting traits
Home-page: https://github.com/enthought/trait-documenter
Author: Ioannis Tziakos
Author-email: info@enthought.com
License: BSD
Description: Trait-Documenter
        ================
        
        .. image:: https://travis-ci.org/enthought/trait-documenter.svg?branch=master
           :target: https://travis-ci.org/enthought/trait-documenter
        
        .. image:: http://codecov.io/github/enthought/trait-documenter/coverage.svg?branch=master
           :target: http://codecov.io/github/enthought/trait-documenter?branch=master
        
        .. image:: https://readthedocs.org/projects/trait-documenter/badge/?version=latest
           :target: https://readthedocs.org/projects/trait-documenter/?badge=master
        
        
        Trait-Documenter is an autodoc extension to allow trait definitions to be
        properly rendered in sphinx.
        
        Installation
        ============
        
        Developments versions can be found in `github <https://github.com/enthought/trait-documenter.git>`_. 
        
        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.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Framework :: Sphinx :: Extension
Classifier: Topic :: Documentation :: Sphinx
