sphinx-me

狮身人面像，我是一个Python的工具，将为您的项目狮身人面像文档壳，包括自述文件中的文档索引＆NBSP;它可以处理提取所需的元数据，如项目名称，作者，版本从您项目在您的狮身人面像文档使用。
一旦你使用狮身人面像，我建立的狮身人面像文档，那么你就可以在你的项目添加到阅读文档的网站，有你的项目的自述举办一个有吸引力的狮身人面像文档主题。
注意：您的README文件应在reStructuredText的兼容格式。
安装
最简单的方法来安装狮身人面像，我是直接从PyPI上使用PIP或setuptools的运行下面的命令分别：
PIP安装-U狮身人面像，我
或：
easy_install的-U狮身人面像，我
否则，你可以下载狮身人面像，我直接从源代码安装：
蟒蛇setup.py安装
运行
狮身人面像，我将安装为，可以通过命令行，同时在项目的根目录下运行全系统的脚本：
狮身人面像，我
当你的项目的目录中运行，它会创建两个文件，​​狮身人面像conf.py模块和index.rst文件，其中包括项目的README一个文档目录。
该conf.py模块调用从设置功能狮身人面像，我设置了最低要求设置您的狮身人面像文档。
- 项目 - 项目的目录名称使用。
- 版 - 从你的setup.py脚本，或者你的包的__version__属性的版本ARG检索。
- 版权 - 从你的setup.py脚本，或者你的包的__author__属性的作者ARG检索

要求：

• 。蟒蛇