Retaining inline code inside references in Sphinx

风流意气都作罢 提交于 2019-12-13 11:51:55

问题


In Sphinx, if I have the following heading declaration:

.. _somestuff:

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

It renders, like this:

    this is code, this is not!

Which is good, but, if I use the reference, e.g:

Have a look at :ref:`somestuff`

It loses the code formatting and renders like:

    Have a look at this is code, this is not!

instead of:

    Have a look at this is code, this is not!


Is it possible to retain the code formatting in the reference? And how would I go about it?


回答1:


If you have a look at :ref: documentation in its official web site about inline markups:

:ref:

To support cross-referencing to arbitrary locations in any document, the standard reST labels are used. For this to work label names must be unique throughout the entire documentation ...

I think (as @Kevin Horn) it's no possible right now, because it's only used to create links (without rst formatting) with other sections in your project. Then if you write something like this:

.. _somestuff:

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

.. _another_somestuff:

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

If I link with these sections:

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

The result is:


Have a look at this is code, this is not!

Have a look at this is another code!

Have a look at this link


The style is the same in all of them .

Note: the italic/bold words symbolize links



来源:https://stackoverflow.com/questions/8091979/retaining-inline-code-inside-references-in-sphinx

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!