我正在为一些python项目编写文档.我在连接两个或多个文档时遇到问题 – 我有三个Sphinx项目(文档),我希望能够在一般文档中添加指向详细文档的链接.
我有这样一个项目结构:
project/
| doc/ # this is my general doc
| | source/ # sphinx general doc .rst files are here
| | build/
| | _static/
| | _templates/
| | CVS/
|
|
| forms/
| | doc/
| | | source/ # sphinx forms doc .rst files are here
| | | build/
| | | _static/
| | | _templates/
| | | CVS/
| |
| | src/ # forms source .py files are here
|
| tables/
| | doc/
| | | source/ # sphinx tables doc .rst files are here
| | | build/
| | | _static/
| | | _templates/
| | | CVS/
| |
| | src/ # tables source .py files are here
Forms doc和Tables doc都包含使用的源文件生成的文档
.. automodule ::指令.
如何在常规文档中创建表单和表格文档的链接?
也许我需要重组一些东西?
我已经阅读了一些关于intersphinx的内容,但到目前为止,我已经找到了只展示如何链接的示例
Python标准库文档通过在sphinx项目的conf.py文件中指定URL,如下所示:
intersphinx_mapping = {'python': ('http://docs.python.org/3.2', None)}
我不知道如何使用与标准库和我不同的东西来创建这样的东西
想要
通过相对路径而不是URL指定其位置 – 任何想法?
解决方法:
intersphinx配置中的位置(在您的示例中为“http://docs.python.org/3.2”)实际上可以是目录的任何URI或路径,其中有一个名为objects.inv的文件,该文件由HTML创建构建器并包含名称和链接的注册表.尝试使用’../forms/_build/html’之类的东西.