在 reStructuredText 中格式化链接中的文本

Question

如何格式化 reStructuredText 中指定链接内的文本？

具体来说，我希望从我的第一个代码生成以下 HTML：

<a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a>

结果应如下所示：

optparse.OptionParser 文档

，其中“optparse.OptionParser”部分采用固定宽度字体。

但是我尝试

```optparse.OptionParser`` <http://docs.python.org/library/optparse.html>`_

过，这

<tt class="docutils literal">`optparse.OptionParser</tt> documentation &lt;<a class="reference external" href="http://docs.python.org/library/optparse.html">http://docs.python.org/library/optparse.html</a>&gt;`_

看起来像这样

``optparse.OptionParser<代码> 文档\_

Answer 1

这个构造：

Here you have |optparse.OptionParser|_.

.. |optparse.OptionParser| replace:: ``optparse.OptionParser`` documentation
.. _optparse.OptionParser: http://docs.python.org/library/optparse.html

生成这个 HTML（添加了一些换行符）：

<p>Here you have 
  <a class="reference external" href="http://docs.python.org/library/optparse.html">
  <tt class="docutils literal"><span class="pre">optparse.OptionParser</span></tt> documentation</a>.
</p>

我意识到这并不完全是您所要求的，但也许它已经足够接近了。另请参阅http://docutils.sourceforge.net/FAQ.html #is-nested-inline-markup-possible。

Answer 2

您尝试过 intersphinx 吗？使用该扩展，以下标记：

:py:class:`optparse.OptionParser`

生成此 HTML：

<a class="reference external" href="http://docs.python.org/2.6/library/optparse.html#optparse.OptionParser" title="(in Python v2.6)"><tt class="xref py py-class docutils literal"><span class="pre">optparse.OptionParser</span></tt></a>

使用 Python 2.6 和 Sphinx 1.0.5 进行测试。

Answer 3

摘自 mzjn 引用的同一常见问题解答页面：

The "raw" directive can be used to insert raw HTML into HTML output:

Here is some |stuff|.

.. |stuff| raw:: html

   <em>emphasized text containing a
   <a href="http://example.org">hyperlink</a> and
   <tt>inline literals</tt></em>

理论上应该可以用 RST 做不到的复杂事情。

Answer 4

如果您想本质上

<span class="red">This is red text</span>

使用 Sphinx 获得与 reStructuredText 中的 HTML/CSS 等效的内容，您可以通过创建一个角色来实现：

.. role:: red

然后像这样使用它：

:red:`This is red text`

应该只有一个刻度线 `上面那行的末尾。
当然，您必须将其包含

.red { color: red }

在 CSS 文件中。