Sphinx 添加代码格式:ref:

问题描述 投票:0回答:1

我想向参考添加代码格式,如下所示:

:ref:`__slots__ <python:slots>`

我的

intersphinx_mapping
定义
python
如下:

intersphinx_mapping = {
    'python': ('https://docs.python.org/3', None),
}

所以链接是https://docs.python.org/3/reference/datamodel.html#slots

slots
std:label
https://docs.python.org/3/objects.inv
部分定义)

我的目标是以

:py:attr:
或类似的样式格式化渲染的链接,而不是
:ref:
渲染的默认文本样式。

以下选项均无效:

  • ... ``:ref:`__slots__ <python:slots>``` ...
    产生类似

    的输出

    ...

    :ref:`__slots__ <python:slots>`
    ...

  • ... ``:ref:`__slots__ <python:slots>` `` ...
    产生类似

    的输出

    ... __插槽__ ...

  • ... :ref:```__slots__`` <python:slots>` ...
    产生类似

    的输出

    ... :参考:```__slots__`` ` ...

    在这种情况下,有两个单独的内部链接到

    #id1

  • ... :ref:` ``__slots__`` <python:slots>` ...
    产生类似

    的输出

    ... :参考:` ``__slots__`` ` ...

``...``
内部或外部用
:code:`...`
:literal:`...`
替换
:ref:
也没有任何帮助。事实上,似乎根本不允许嵌套角色。

我想要一个内联角色,它会产生使用代码样式和链接呈现的内容,例如

...

__slots__
...

如何让基本

:ref:
(或同等内容)以
:py:attr:
使用的代码样式格式显示?

我在 Anaconda 环境中使用 Sphinx 1.6.3 和 Python 3.6.2。

反问题在这里:Sphinx 从自定义代码参考中删除代码格式

一个切线相关的问题:嵌套/复合角色:将多个角色应用于重叠文本

python python-sphinx restructuredtext
1个回答
3
投票

:any:
角色可以满足您的需求:

:any:`__slots__ <python:slots>`

这是一个“便利角色”,用于查找当前域中的交叉引用目标以及与

:ref:
一起使用的目标。

Python 域针对不同类型的对象有多个特定的交叉引用角色

© www.soinside.com 2019 - 2024. All rights reserved.