sphinxgen 1.3.0.0-r5

What?

sphinxgen用于从找到的python包和模块生成文件 在指定的目录集中。它用于生成sphinx autodoc 存根文件，但可以用于其他目的。文件是使用 {A12}模板以提供最大的柔韧性。您可以使用一组内置的 模板，或提供您自己的。

Install?

使用pip：

$ pip install sphinxgen

或者，来源：

$ python setup.py install

Examples?

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

也可以将其用作setuptools命令：

#setup.cfg[sphinxgen]package_dirs=src/python/my_package,src/python/my_other_packageoutput=sphinx/source

> setup.py sphinxgen

Dependencies?

sphinxgen是针对python版本2.7开发的。

其他依赖项由pip处理。

要使用sphinx从源代码构建文档，您需要列出 在sphinx/requirements.pip下。

Docs?

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

Contact Information

此项目当前托管在bitbucket， 在https://bitbucket.org/bmearns/sphinxgen。 主要作者是Brian Mearns，您可以通过Bitbucket在 https://bitbucket.org/bmearns。

Copyright and License

sphinxgenisfree software：您可以重新分发和/或修改它 根据gnu通用公共许可证的条款 自由软件基金会，或者许可证的第3版，或者 （由您选择）任何更高版本。

sphinxgen被分发是希望它会有用， 但是没有任何保证；甚至没有 适销性或适合特定用途。见 GNU通用公共许可证了解更多详细信息。

GNU通用公共许可证的副本可在 sphinxgen文件license.txt下的分发。如果你没有 接收此文件的副本，请参见 http://www.gnu.org/licenses/。