Sphinx指令到另一个页面

时间:2013-08-08 21:33:12

标签: python python-sphinx

我有2页包含在toc中。

在第1页,我有以下

The link :py:class:`testtest`

在第2页我有

The link :py:class:`testtest`
.. autoclass:: testtest

在第2页上,该链接正在运行,因为该类已使用autoclass自动记录。

为什么page_1上的相同链接不起作用?如何在不包含第1页的autoclass指令的情况下使其工作?

谢谢,

1 个答案:

答案 0 :(得分:0)

page_1不知道在哪里找到testtest - page_2找到它,因为它隐含地查找节点的“范围”(可以这么说),直到找不到它它。这样做的:

:py:class:`module.testtest`
page_1中的

应该有效(如果您的路径设置正确),您也可以这样做:

:py:class:`~module.testtest`

仅将testtest作为链接文字。为了避免必须使用模块前缀,您可以使用.. currentmodule:: modulename指令,但一次只能应用其中一个,因此如果您在多个模块中重新编写内容,则无法真正保存输入。< / p>

http://sphinx-doc.org/domains.html#directive-py:currentmodule
http://sphinx-doc.org/markup/inline.html#xref-syntax
http://sphinx-doc.org/domains.html#cross-referencing-python-objects