sphinx-me 0.3

简介

有只需要自述文件的小python项目吗 为了文件？想在Read The Docs上主持自述吗？

sphinx me是一个BSD licensed工具，它将创建一个Sphinx 项目的文档shell，并包括自述文件 作为文档索引。它处理提取所需的元 项目中的项目名称、作者和版本等数据 在你的狮身人面像文件中使用。

一旦你用狮身人面像我来建造你的狮身人面像文件，你就可以 将您的项目添加到“阅读文档”网站，并使您的项目 自述文件的主题很吸引人。

安装

安装sphinx me最简单的方法是直接从PyPI使用 pip或setuptools通过运行下面的相应命令：

$ pip install -U sphinx-me

或：

$ easy_install -U sphinx-me

否则你可以下载sphinx me直接安装 来源：

$ python setup.py install

运行

sphinx me将作为系统范围的脚本安装，可以从 在项目根目录中的命令行：

$ sphinx-me

在项目目录中运行时，它将创建一个docs目录 有两个文件，sphinx conf.py模块和index.rst文件 包括你的项目自述。

conf.py模块从sphinx me调用设置函数 斯芬克斯文档所需的最低设置。

• ^{tt5}$ - the directory name of your project is used.
• ^{tt6}$ - retrieved from the ^{tt6}$ arg of your ^{tt8}$ script, or your package’s ^{tt9}$ attribute.
• ^{tt10}$ - retrieved from the ^{tt11}$ arg of your ^{tt8}$ script, or your package’s ^{tt13}$ attribute.

运行此进程还将执行初始的sphinx-build 在项目的docs/build目录中。后续生成 对自述文件进行更改后，可以通过运行 再次使用sphinx me，或者使用常规的sphinx-build命令。

在阅读文档时托管

在Read The Docs上托管sphinx me生成的文档时，您 必须确保选中use virtualenv选项并指定 sphinx-me作为setup.py脚本的要求， 或者在pip requirements file中，您还需要在 阅读文档时项目的需求文件字段。