两个文档之间的Sphinx连接

时间:2012-07-27 10:21:32

标签: python documentation python-sphinx

我正在为一些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)}

我不知道如何使用与标准库和我不同的东西创建这样的东西 想要

按相对路径指定其位置而不是网址 - 任何想法?

1 个答案:

答案 0 :(得分:3)

intersphinx配置中的位置(在您的示例中为“http://docs.python.org/3.2”)实际上可以是目录的任何URI或路径,其中有一个名为objects.inv的文件,该文件已创建由HTML构建器,并包含名称和链接的注册表。尝试使用像'../ forms / _build / html'这样的东西。