首页 / PYTHON / python – 如何链接到intersphinx中的根页面

python – 如何链接到intersphinx中的根页面

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了python – 如何链接到intersphinx中的根页面，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含2760字，纯文字阅读大概需要4分钟。

内容图文

我在项目中启用了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>`,我得到警告：未定义标签：pyserial(如果链接没有标题,标签必须在节标题之前)

如果我这样做：ref：`pyserial<>`我得到警告：未定义标签:(如果链接没有标题,标签必须在节标题之前)

我可以用`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.

解决方法:

您已满足以下要求.这是最后一个令人沮丧的常见问题.

>配置项目以使用intersphinx.
>远程文档使用Sphinx,实际上有一个名为objects.inv的清单文件.运行sphinx-build时,日志条目应该是这样的：

loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://pythonhosted.org/pyserial/objects.inv...

>使用intersphinx的Python项目的语法如下,就像任何cross-referencing link一样：

:role_name:`title <target>`

所以在你的情况下：

:ref:`pyserial <pyserial:reference-label-name>`

>最后,给定页面的库存中可能不存在某些所需目标. This answer shows how to see all intersphinx targets,使用以下内容：

python -m sphinx.ext.intersphinx 'https://pythonhosted.org/pyserial/objects.inv'

出现所有API对象,这就是您可以链接到这些对象的原因,但只存在有限数量的其他对象：

std:label
        examples                                 Examples                                : examples.html#examples
        genindex                                 Index                                   : genindex.html#
        miniterm                                 serial.tools.miniterm                   : tools.html#miniterm
        modindex                                 Module Index                            : py-modindex.html#
        search                                   Search Page                             : search.html#
        urls                                     URL Handlers                            : url_handlers.html#urls

缺乏任意标签是作者常见的烦恼.

你也可以check the project’s reST source for targets,在这种情况下,没有像… _my-reference-label：这样的参考标签.

要解决此问题,您可以使用以下任意一个目标：

:ref:`pyserial <pyserial:genindex>`

…或者更好的是向项目提交拉取请求,在该项目中,您至少为索引页面提供标签,等待其接受,然后将其用于intersphinx链接.其他作者会很感激.

内容总结

以上是互联网集市为您收集整理的python – 如何链接到intersphinx中的根页面全部内容，希望文章能够帮你解决python – 如何链接到intersphinx中的根页面所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/819539.html

来源：【匿名】