Sphinx

Sphinx#

构建#

PDF#

安装 LaTex 依赖:

# pacman -S texlive-most

如果遇到了 FS#67856:

# pacman -S texlive-langchinese

构建:

$ make latexpdf

文件会生成在 _build/latex/*.pdf。

扩展#

intersphinx#

查看 Sphindx 文档中可供 intersphinx 索引的 ref

开发#

文档#

Spihinx Objects
Nodes
Directives

测试#

Test Fixtures

sphinx.testing.fixture.app() 实现了一个 pytest fixture 能够返回一个测试用的 application 对象 sphinx.testing.utilSphinxTestApp。

在 sphinx/tests 目录下直接使用名为 app 的参数即可使用这个 fixture，例如：

sphinx-doc/sphinx#files#
def test_intersphinx_cache_limit(app):
    url = 'https://example.org/'
    app.config.intersphinx_mapping = {
        'inv': (url, None),
    }
    # ...
评论

如果你有任何意见，请在此评论。 如果你留下了电子邮箱，我可能会通过 回复你。