README

docit is a python package which provides some simple tools to use with sphinx autodoc to control whether or not members are included in the documentation or not.

tl;dr

What?

A sphinx extension to control autodoc for individual members.

Install?

$ pip install docit

Or, from source:

$ python setup.py install

Examples?

>>> import docit
>>>

Dependencies?

docit is developed against python version 2.7.

To build the sphinx docs from source (as is), you’ll need the sphinx_rtd_theme:

$ pip install sphinx_rtd_theme

Docs?

• Read The Docs (.org)
• Python Hosted (.org)

Misc.

Contact Information

This project is currently hosted on bitbucket, at https://bitbucket.org/bmearns/docit. The primary author is Brian Mearns, whom you can contact through bitbucket at https://bitbucket.org/bmearns.

Copyright and License

docit is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

docit is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. See the GNU General Public License for more details.

A copy of the GNU General Public License is available in the docitdistribution under the file LICENSE.txt. If you did not receive a copy of this file, see http://www.gnu.org/licenses/.