我在我的项目中启用了sphinx.ext.intersphinx
,并添加了以下配置:
intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
'pyserial': ('https://pythonhosted.org/pyserial/', None),
}
我在我的index.rst
文件中有以下内容:
This project depends on the :ref:`pyserial <pyserial:???>` library.
我希望链接指向
http://pythonhosted.org/pyserial/
,这是intersphinx_mapping
中的根URL,但我不知道???
应该填什么。如果我使用
:ref:`pyserial`
或:ref:`pyserial <pyserial>`
,我会得到WARNING: undefined label: pyserial (if the link has no caption the label must precede a section header)
。如果我使用
:ref:`pyserial <>`
,我会得到WARNING: undefined label: (if the link has no caption the label must precede a section header)
。我可以用
`pyserial <http://pythonhosted.org/pyserial/>`_
替换:ref:
,但我真的想通过intersphinx引用页面,以避免将来出现链接失效的情况。我正在使用Anaconda中的Python 3.6.2上的sphinx 1.6.3。我并不特别关注我要链接的库。我认为答案与库无关。
如果有影响的话,对pyserial文档的常规引用完全正常。例如,
:py:class:`serial.Serial`
链接到https://pythonhosted.org/pyserial/pyserial_api.html#serial.Serial。
python
和pyserial
文档中的“示例”标签? - Mad Physicist<python:examples>
和<pyserial:examples>
,因为我无法在注释中使用文字反引号。 - Steve Piercy