在狮身人面像和示例待办事项清单中保留换行符

时间:2018-08-29 16:04:05

标签: python documentation python-sphinx

试图弄清楚如何在sphinx中将换行符添加到待办事项列表中。

2 个答案:

答案 0 :(得分:1)

我无法为此找到一个很好的答案,最终将一些不同的事情放在一起,最终解决了。

基本上,我试图在我的狮身人面像文档中放入待办事项清单。但是.. todolist ::不在打印中,而.. todo ::只是排成长行而没有换行符。因此,将其添加到主index.rst文件的底部:

.. |br| raw:: html

   <br />

然后在我的待办事项列表中执行以下操作:

.. todo:: 

   - blah |br|
   - blah |br|
   - blah |br|

在此过程中出现了一个如下所示的待办事项框:

enter image description here

希望这可以节省一些时间!

答案 1 :(得分:0)

不需要替换|br|。本示例可以正常工作并产生语义正确的HTML列表项,而不是换行符。如果您对视觉效果不满意,则应使用自定义CSS。

.. todo::

    - blah
    - blah
    - blah

Todo List Items

<p class="first admonition-title">Todo</p>
<ul class="last simple">
<li>blah</li>
<li>blah</li>
<li>blah</li>
</ul>