标签: cross-reference

在 Markdown 中，可以像这样创建内联代码链接

[`dict.update`](https://docs.python.org/3/library/stdtypes.html#dict.update)

渲染效果如下dict.update。如何在 reStructuredText / Sphinx 中获得类似的行为？我尝试（1）使用转换器，但它永远不会产生类似的结果（2）嵌套外部链接`link <link>`_和内联代码块:code:`dict.update`，但这也不起作用。

我想在 R Markdown 文档中的参考书目之后添加表格和数字。但是，默认情况下，R Markdown 文档将始终将参考书目添加到报告的末尾。

有没有一种简单的方法可以在引用后向文档添加内容？

尝试的解决方案

一个以前的答案表明，就是把附录中的R在降价后书目的方式。此附录是一个单独的文件，并after_body通过 YAML 标头添加到文档中。我尝试了 2 种不同的可能解决方案，但都没有奏效。

1. 我试图将我的附录放在不同的文件中，但我遇到了在主文件中丢失引用的问题，因为所有附录都在论文正文中交叉引用。所有参考文献都转向?? 一旦我将它们放在不同的文件中。
2. 我将所有图形和表格放在不同的文件中，同时将它们保存在主文件中。然后，我曾经results = "hide"将它们隐藏在主文件中。这个想法是创建 2 个单独的 PDF 并合并它们。不幸的是，当数字被隐藏时，参考也变成了?? .

附加信息

• 我正在使用输出格式 bookdown:pdf_document2
• 我的数字是由一个.R文件创建的，并使用include_graphics().

我在交叉引用自定义指令生成的部分时遇到问题。

这是指令：

from docutils import nodes
from docutils.parsers import rst


class TestDirective(rst.Directive):

    has_content = False
    required_arguments = 1
    option_spec = {}

    def run(self):
        my_arg = self.arguments[0]

        target_node = nodes.target('', '', refid=nodes.make_id(my_arg))
        section = nodes.section(
            '',
            nodes.title(text=my_arg),
            ids=[nodes.make_id(my_arg)],
            names=[nodes.fully_normalize_name(my_arg)])

        return [target_node, section]


def setup(app):
   app.add_directive('mytest', TestDirective)

这是它的使用方法：

=============
Test document
=============

.. mytest:: section1

Section 1 content.


.. _section2:

section2
========

Section 2 content.

现在，以下仅适用于section2：

Here are links to :ref:`section1` and :ref:`section2`.

该链接仅正确生成section2，我收到以下错误：

test.rst:19: WARNING: undefined label: …

参考链接如何在OCaml中工作？

例如,假设我有3个模块声明为

• A.ml
• B.ml
• C.ml

其中

• A需要B和C
• B 需求 A

我该如何进行编译？

由于订单是相关的,ocamlc或者ocamlopt我如何修复B和之间的交叉参考A？

我想首先他们都汇编成.cmo用ocamlc -c,然后链接所有的人都在一起,但自从与交换参数将刚刚从一个模块移动到另一个问题没有成功.

具体错误是:

错误:链接A.cmo时出错:引用未定义的全局`B'

(或者反之,如果我交换了args的顺序)

我认为这是一个简单的问题,但我无法解决它...提前感谢

考虑两个模块（在同一文件夹中）：

首先，person.py

from typing import List
from .pet import Pet


class Person:
    def __init__(self, name: str):
        self.name = name
        self.pets = [] # type: List[Pet]

    def adopt_a_pet(self, pet_name: str):
        self.pets.append(Pet(pet_name))

然后是pet.py

from .person import Person


class Pet:
    def __init__(self, name: str, owner: Person):
        self.name = name
        self.owner = owner

由于循环依赖，上述代码无法正常工作。您会得到一个错误：

ImportError: cannot import name 'Person'

使其工作的一些方法：

1. 将类Person和Pet的定义保存在同一文件中。
2. 删除pet.owner属性（方便使用的指针）
3. 不要在会引起循环引用的地方使用type-hinting / annotation：

例如：

class Pet:
    def __init__(self, name: str, owner):

到目前为止，我列出的所有选项中都有一些缺点。

还有另一种方法吗？一个让我能够

• 将类拆分为不同的文件
• 将类型注释与指针结合使用，如图所示

或者：是否有充分的理由改而采用我已经列出的解决方案之一？

我正在使用四开本创建一份长 PDF 报告。我想包括两种格式的交叉引用：

1. 到章节/图号，例如

正如3.1 节中讨论的

---
format:   
  pdf:
    number-sections: true
---

# Why Stack Overflow is so great {#sec-stack}

I can use style 1, the section number, with the explicit ID, e.g. as seen in @sec-stack.

I can use style 2, the section title, with a link [Why Stack Overflow is so great].

I can also custom text with [Custom text before the link][Why Stack Overflow is so great].