sphinx-pyproject 0.3.0

安装

sphinx-pyproject 可以从PyPI或Anaconda安装。

使用 pip 安装

$ python -m pip install sphinx-pyproject

使用 conda 安装

• 首先添加所需的渠道

$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding

• 然后安装

$ conda install sphinx-pyproject

使用

SphinxConfig 类将从 pyproject.toml 加载配置。通过将 globalns=globals() 传递给类构造函数，从 pyproject.toml 文件解析的键将添加到 conf.py 文件的全球命名空间中。

例如

# conf.py

from sphinx_pyproject import SphinxConfig

config = SphinxConfig("../pyproject.toml", globalns=globals())

author  # This name *looks* to be undefined, but it isn't.

SphinxConfig 类还提供了一个 collections.abc.Mapping 接口。如果您在解析后要覆盖或修改配置值之一，建议的方法是显式分配名称

extensions = config["extensions"]
extensions.append("sphinx.ext.autodoc")

这将防止来自代码检查器等工具的警告，但对于 Sphinx 来说并非必要。

此外，SphinxConfig 类接受一个可选参数 config_overrides，该参数可用于动态更新来自 pyproject.toml 的值。这有助于设置动态值，如 version。

# conf.py
from sphinx_pyproject import SphinxConfig

from myproject import __version__ as myproject_version

config = SphinxConfig("../pyproject.toml", globalns=globals(), config_overrides = {"version": myproject_version})