Skip to main content
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!

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.

Release History

Release History

This version
History Node

1.3.0.0-r5

History Node

1.2.0.0-r4

History Node

1.1.1.0-r3

History Node

1.1.0.0-r2

History Node

1.0.0.0-r1

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
sphinxgen-1.3.0.0_r5-py2.7.egg (23.5 kB) Copy SHA256 Checksum SHA256 2.7 Egg Dec 3, 2014
sphinxgen-1.3.0.0_r5-py2-none-any.whl (12.6 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Dec 3, 2014
sphinxgen-1.3.0.0-r5.tar.bz2 (33.3 kB) Copy SHA256 Checksum SHA256 Source Dec 3, 2014
sphinxgen-1.3.0.0-r5.tar.gz (38.0 kB) Copy SHA256 Checksum SHA256 Source Dec 3, 2014
sphinxgen-1.3.0.0-r5.win32.exe (245.2 kB) Copy SHA256 Checksum SHA256 any Windows Installer Dec 3, 2014
sphinxgen-1.3.0.0-r5.zip (46.1 kB) Copy SHA256 Checksum SHA256 Source Dec 3, 2014

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