latex - Sphinx对包含节号和节标题的其他节的引用

Question

我正在使用Sphinx编写包含大量引用的文档:

.. _human-factor:

The Human Factor
================

...

(see :ref:`human-factor` for details)

编译后的文档包含以下内容:

(有关详细信息，请参见人为因素)

相反，我希望将其格式化为:

(有关详细信息，请参见5.1人为因素)

我试图用谷歌的解决方案，我发现， latex hyperref包可以做到这一点，但我不知道如何将其添加到Sphinx构建。

Answer 1

我基本上是从这里使用numsec.py来解决它的:https://github.com/jterrace/sphinxtr

我必须用此函数替换doctree_resolved函数，以获取节号和标题(例如“5.1 The Human Factor”)。

def doctree_resolved(app, doctree, docname):
    secnums = app.builder.env.toc_secnumbers
    for node in doctree.traverse(nodes.reference):
        if 'refdocname' in node:
            refdocname = node['refdocname']
            if refdocname in secnums:
                secnum = secnums[refdocname]
                emphnode = node.children[0]
                textnode = emphnode.children[0]

                toclist = app.builder.env.tocs[refdocname]
                anchorname = None
                for refnode in toclist.traverse(nodes.reference):
                    if refnode.astext() == textnode.astext():
                        anchorname = refnode['anchorname']
                if anchorname is None:
                    continue
                linktext = '.'.join(map(str, secnum[anchorname]))
                node.replace(emphnode, nodes.Text(linktext
                    + ' ' + textnode))

为了使其工作，需要在conf.py中包括numsec扩展名，并且还需要在toctree中添加:numbered:，如下所示:

.. toctree::
   :maxdepth: 1
   :numbered: