documenting/sphinx

Sphinx构建系统

构建配置文件

在文档的根目录里,即源代码的”Doc”子目录,有一个叫做”conf.py”的构建配置文件,它包含一些在构建运行时需要使用的变量。

这些变量是:

version : string

|version| 的替代,指使用的Python版本。它只包含主版本号和次版本号,如”2.5”,即使Python版本是2.5.1。

release : string

A string that is used as a replacement for the |release| reST substitution. It should be the full version string including alpha/beta/release candidate tags, e.g. 2.5.2b3.

Both release and version can be 'auto', which means that they are determined at runtime from the Include/patchlevel.h file, if a complete Python source distribution can be found, or else from the interpreter running Sphinx.

today_fmt : string

A strftime format that is used to format a replacement for the |today| reST substitution.

today : string

A string that can contain a date that should be written to the documentation output literally. If this is nonzero, it is used instead of strftime(today_fmt).

unused_files : list of strings

A list of reST filenames that are to be disregarded during building. This could be docs for temporarily disabled modules or documentation that’s not yet ready for public consumption.

last_updated_format : string

If this is not an empty string, it will be given to time.strftime() and written to each generated output file after “last updated on:”.

use_smartypants : bool

If true, use SmartyPants to convert quotes and dashes to the typographically correct entities.

add_function_parentheses : bool

If true, () will be appended to the content of :func:, :meth: and :cfunc: cross-references.