Skip to main content

UNKNOWN

Project description

tl;dr

What?

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.

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.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxgen-1.3.0.0_r5-py2.7.egg (23.5 kB) Copy SHA256 hash SHA256 Egg 2.7
sphinxgen-1.3.0.0_r5-py2-none-any.whl (12.6 kB) Copy SHA256 hash SHA256 Wheel 2.7
sphinxgen-1.3.0.0-r5.tar.bz2 (33.3 kB) Copy SHA256 hash SHA256 Source None
sphinxgen-1.3.0.0-r5.tar.gz (38.0 kB) Copy SHA256 hash SHA256 Source None
sphinxgen-1.3.0.0-r5.win32.exe (245.2 kB) Copy SHA256 hash SHA256 Windows Installer any
sphinxgen-1.3.0.0-r5.zip (46.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page