生成假的intersphinx库存

sphinx-fakeinv的Python项目详细描述


有时我们创建的库太小,不需要使用 Sphinx对于它们,但同时我们可能希望将它们从 其他使用狮身人面像书写的文件。

这个实用程序帮助我们生成一个假的objects.inv文件 (它也被称为sphinx目录)以便其他sphinx文档可以链接 它通过Intersphinx扩展。

安装

它被上传到PyPI,因此您可以使用pip

$ pip install sphinx-fakeinv

用法

假设您刚刚编写了一个名为foobar的小模块。你可以生成 一个假的objects.inv,通过以下命令:

$ sphinx-fakeinv foobar > objects.inv

shinx-fakeinv程序自动扫描子模块、子包, 以及所有扫描模块/包中的类/函数/异常/变量。 (注意,它知道__all__list(如果有的话)。

如果要从其他sphinx文档链接它,需要手动添加url 当然你需要上传生成的假objects.inv 像gh页)到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()`.

上面例子中的链接如foobarfoobar.baz()将引用 到https://github.com/example/foobar

作者和许可证

Hong Minhee撰写。分布在GPLv3或更高版本下。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
关于如何将spring mvc重构为普通servlet或jetty处理程序的java建议   java循环和处理数据输入错误   使用java获取更改内容   java试图向一个数组中添加5张不同的“卡”,但它正在添加5张相同的卡   Java函数在Matlab类中变得未定义   多线程Java使用对象作为监视器,那个对象不是太重了吗?   将MySQL日期转换为Java日期:Android   java ResourceBundle在哪里。getBundle(“ResourceFile”,新语言环境(“us”,“us”))查找该文件?   java第一人称摄影机卷   如何在java中交替使用两个字符   addActionListener上下文中的java“this”   几天后,java Grails和Jasig CAS重定向循环   JavaAnt如何在javac中使用exclude、excludesfile?   java如何设置单行RecyclerView上的文本?