使用适当的intersphinx设置,您可以从您自己的文档链接到Django类,如下所示:
:class:`django:django.db.models.Model`
但是你如何链接到一个设置? Django使用自己的:setting:为此构造而不是内置的类似:class:.如何使用intersphinx链接到设置?
我尝试过各种各样的咒语,但都没有用(有些可能是错误的):
:ref:`django:ROOT_URLconf` :ref:`django:root_URLconf` :setting:`django:ROOT_URLconf` :ref:`django:setting:ROOT_URLconf` :django:setting:`ROOT_URLconf`
解决方法
问题是:我的本地狮身人面像并不知道Django的自定义狮身人面像角色,比如设置.所以这是一个非常精细的intersphinx参考:
:django:setting:`ROOT_URLconf`
在你告诉Sphinx关于intersphinx目标的自定义角色之前不行.
最后通过将Django’s sphinx extension中的一个小片段复制为我的文档旁边的_ext / djangodocs.py来实现它:
def setup(app): app.add_crossref_type( directivename = "setting",rolename = "setting",indextemplate = "pair: %s; setting",)
import os import sys ... sys.path.append( os.path.abspath(os.path.join(os.path.dirname(__file__),"_ext"))) # ^^^ I'll do that neater later on. extensions = ['djangodocs',# ^^^ I added that one. 'sphinx.ext.autodoc',... ] ...
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。