sphinx-fakeinv 1.0.0

安装

已上传到 PyPI，因此您可以使用 pip 安装它

$ pip install sphinx-fakeinv

用法

假设您刚刚编写了一个名为 foobar 的小模块。您可以使用以下命令为其生成一个伪造的 objects.inv

$ sphinx-fakeinv foobar > objects.inv

程序 shinx-fakeinv 会自动扫描所有扫描模块/包的子模块、子包、类/函数/异常/变量。 (注意，如果存在，它会识别 __all__ 列表。)

如果您想从其他 Sphinx 文档中链接它，您需要手动将其 URL (当然您需要将其生成的虚假 objects.inv 上传到像 gh-pages 这样的地方) 添加到 intersphinx_mapping 配置中。

intersphinx_mapping = {
    'foobar': (
        'https://github.com/example/foobar',            # The project website
        'https://example.github.io/foobar/objects.inv'  # The fake inventory
    ),
}

完成了！如果您引用了 foobar，例如。

If :mod:`foobar` module is available at runtime this function will uses
internally :func:`foobar.baz()`.

上面例子中的链接，如 foobar 和 foobar.baz()，将指向 https://github.com/example/foobar。

作者和许可

由 Hong Minhee 编写。根据 GPLv3 或更高版本分发。