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.
> 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
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.
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/.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size sphinxgen-220.127.116.11_r5-py2.7.egg (23.5 kB)||File type Egg||Python version 2.7||Upload date||Hashes View|
|Filename, size sphinxgen-18.104.22.168_r5-py2-none-any.whl (12.6 kB)||File type Wheel||Python version 2.7||Upload date||Hashes View|
|Filename, size sphinxgen-22.214.171.124-r5.tar.bz2 (33.3 kB)||File type Source||Python version None||Upload date||Hashes View|
|Filename, size sphinxgen-126.96.36.199-r5.tar.gz (38.0 kB)||File type Source||Python version None||Upload date||Hashes View|
|Filename, size sphinxgen-188.8.131.52-r5.win32.exe (245.2 kB)||File type Windows Installer||Python version any||Upload date||Hashes View|
|Filename, size sphinxgen-184.108.40.206-r5.zip (46.1 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for sphinxgen-220.127.116.11_r5-py2-none-any.whl