README¶

Page Contents

tl;dr
- What?
- Install?
- Examples?
- Dependencies?
- Docs?
Misc.
- Contact Information
- Copyright and License

sphinxgen is used to generate files from python packages and modules found in a specified set of directories. It is intended for generating sphinx autodoc stub files, but can be used for other purposes. Files are generated using jinja templates to provide maximum flexbility. You can use a set of built-in templates, or provide your own.

Install?¶

Install with pip:

$ pip install sphinxgen

Or, from source:

$ python setup.py install

Examples?¶

> sphinxgen -o sphinx/source src/python/my_package src/python/my_other_package

You can also use it as a setuptools command:

#setup.cfg

[sphinxgen]
package_dirs = src/python/my_package,src/python/my_other_package
output = sphinx/source

> setup.py sphinxgen

Dependencies?¶

sphinxgen is developed against python version 2.7.

Other dependencies are handled by pip.

For building the docs from source with sphinx, you will need the packages listed under sphinx/requirements.pip.

Docs?¶

Misc.¶

Contact Information ¶

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

Copyright and License ¶

sphinxgen 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.

sphinxgen 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 sphinxgendistribution under the file LICENSE.txt. If you did not receive a copy of this file, see http://www.gnu.org/licenses/.