在Sphinx中保留引用中的内联代码

时间:2011-11-11 09:30:09

标签: documentation documentation-generation python-sphinx restructuredtext

在Sphinx中,如果我有以下标题声明:

.. _somestuff:

``this is code``, this is not!
==============================

它呈现,像这样:

this is code,这不是!

哪个好,但是,如果我使用引用,例如:

Have a look at :ref:`somestuff`

它丢失了代码格式并呈现如下:

查看this is code, this is not!

而不是:

查看this is code, this is not!


是否可以在引用中保留代码格式?我该怎么做呢?

1 个答案:

答案 0 :(得分:2)

如果您在official web site中查看有关内联标记的:ref:文档:

  

<强>:参考:

     

支持对任何文档中的任意位置进行交叉引用,   使用标准的reST标签。为此,必须使用标签名称   在整个文档中都是独一无二的......

我认为(作为@Kevin Horn)现在不可能,因为它仅用于创建项目中其他部分的链接(没有第一次格式化)。如果你写这样的东西:

.. _somestuff:

``this is code``, this is not!
==============================

.. _another_somestuff:

this is another code!
========================

如果我链接这些部分:

Have a look at :ref:`somestuff`
Have a look at :ref:`another_somestuff`
Have a look at :ref:`this link <somestuff>`

结果是:


看看 这是代码,这不是!

看看 这是另一个代码!

查看 此链接


所有这些风格都是一样的。

注意:斜体/粗体字代表链接