57得票1回答
将reStructuredText解析为HTML

我正在制作一个框架,让开发人员使用reStructuredText描述他们的软件包。我想将这些reStructuredText解析为HTML,以便在GUI中显示。 我熟悉出色的Sphinx,但从未解析过reStructuredText。我想象中是一个函数,该函数接受reStructuredT...

54得票8回答
ReST删除线

在 Restructured Text 中是否有办法划掉文字? 例如,当转换为 HTML 时,可以呈现为 <strike> 标签的内容,如:ReSTructuredText

24得票4回答
在reStructuredText中将链接插入粗体文本

我尝试在重要的文本中插入链接,但在reStructuredText中失败了。 这是我的rst源代码:**Lorem ipsum dolor sit amet, `consectetur <http://www.example.com>`_ adipisicing elit, s...

21得票5回答
使用自定义文本在reStructuredText中创建内部超链接

我知道如何创建带有自定义文本的外部超链接。`My cool link <http://www.asdf.com>`_ 但我想链接到一个内部参考。.. _foo: Lorem ipsum dolor sit amet, consectetur adipiscing elit, se...

14得票3回答
在reST中指定锚点名称

我正在使用docutils自带的rst2html工具将reST转换为HTML。似乎代码已经将id属性分配给了各个部分,这可以用作URL的片段标识符,即锚点,以跳转到页面的特定部分。这些id值基于节标题的文本。当我更改该标题的措辞时,标识符也会更改,从而使旧URL无效。 是否有一种方式指定要用...

14得票9回答
有没有一款智能编辑器适用于 ReST 文件?

我正在学习Sphinx,并需要编辑ReST文件。是否有智能编辑器支持它?例如,提供代码着色、易于缩进、代码自动完成等功能。

12得票3回答
如何通过终端安装Docutils以使Django admindocs正常工作?

Docutils是一个非常好的软件包。如果你正在使用Django,admindocs软件包需要docutils。有关使用Web浏览器安装的说明可用,但如果您远程通过SSH登录终端怎么办?在这种情况下如何安装?如果您只想要一个快速的终端命令来完成此工作,该怎么办呢?

11得票3回答
在sphinx/docutils中覆盖默认字段名称限制

我使用sphinx为项目生成html文档,并大量使用字段列表。 生成html时,如果标签长度不超过14个字符,则每个标签/值对将呈现为单个表行具有两个单元格。 如果一个标签的长度超过14个字符,则该标签/值将呈现为两个表行。 我想将换行限制提高到更大的值(例如40)。我发现限制由docu...

11得票4回答
Sphinx中的条件toctree

我希望能够创建多个文档版本,这些版本在包含的章节上有所不同。为了实现这一目标,我通常会使用only指令或ifconfig扩展。然而,我无法将它们与toctree指令结合使用。 基本上,我想要的是这样的东西: .. toctree:: :maxdepth: 2 intro ...

10得票1回答
如何在PyCharm中自动生成Python API文档

我在PyCharm中有一个Python项目,我想从我的Python代码和文档字符串自动生成API文档(以HTML形式)。根据此页面,有许多工具可以生成Python API文档: - autosummary - autodoc - pdoc - PyDoc - pydoctor - Doxyg...