gpt4 book ai didi

python-sphinx - 如何在代码块中包含内部引用?

转载 作者:行者123 更新时间:2023-12-04 05:50:11 24 4
gpt4 key购买 nike

在我的 Sphinx .rst 文档中,我有一个代码块,其中包含使用 UNIX tree 的产品结构的 TreeView 。命令:

  |── parent
|   |── child
|   |── grandchild
它位于代码块中,以便 Sphinx 保留空格。
我希望读者能够点击每个节点来关注 internal hyperlink到描述该节点的文档部分。但是,添加 :ref:代码块内部不起作用(见下文)。有谁知道如何实现这一目标?
这不起作用:
.. _parent:

Parent
------
Blah blah

.. _child:

Child
-----
Blah blah

.. _grandchild:

Grandchild
----------
Blah blah
然后...:
|── :ref:`parent`
| |── :ref:`child`
| |── :ref:`grandchild`

最佳答案

您可以使用 parsed-literal 指示:

.. parsed-literal:: 

|── :ref:`parent`
| |── :ref:`child`
| |── :ref:`grandchild`

这可行,但有警告消息说“警告:内联替代引用起始字符串没有结束字符串。”

竖线被解释为 substitution references 的一部分。 .警告随着一些转义而消失:
.. parsed-literal:: 

\|── :ref:`parent`
| \|── :ref:`child`
| \|── :ref:`grandchild`

关于python-sphinx - 如何在代码块中包含内部引用?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/44527391/

24 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com