restructuredtext 相关问题

reStructuredText是一种轻量级标记语言，旨在以源格式高度可读。

如果我定义了一个词汇表和一个叫做foobar的术语，那么我可以在文本中使用该术语，因为这是对：term：`foobar`术语的引用。然后，这会将foobar变成可点击的引用，将我带到...

python-sphinx restructuredtext glossary

回答 1 投票 1

我希望能够在表格内生成目录。例如。它应该具有边框，如下所示：.. tabularcolumns :: | p {10.5cm} | p {1.1cm} | p {1.4cm} | p {1.1cm} | + -----------------------------......

python-sphinx restructuredtext tableofcontents docutils toctree

回答 1 投票 0

在Sphinx RTD网站上每个页面的顶部添加警告指令

我想在Sphinx RTD网站上每个页面的顶部添加一个简单的警告指令：..注意：：该项目的下一个主要版本将于X date启动。同时，我们是...

python-sphinx restructuredtext read-the-docs

回答 1 投票 1

将狮身人面像目录划分为带有小标题的小节

我有一个Sphinx主文档，其中包括以下子文档：.. toctree ::：maxdepth：2：numbered：doc1 doc2 doc3 doc4 doc5 doc6我想划分...

python-sphinx restructuredtext toctree

回答 1 投票 4

隐藏toctree中的特定文件？

我正在本地主机上使用readthedocs.org实例从github存储库构建HTML文档，我希望能够执行以下操作。目前，我有正在读取的文件的列表...

python-sphinx glob restructuredtext toctree

回答 1 投票 3

如何在Sphinx文档中显式呈现空白？

我是sqlfluff的维护者之一，我想在这里将类似的模式和反模式示例复制到flake8文档中：https://www.flake8rules.com/rules/E101.html目前...

whitespace python-sphinx restructuredtext autodoc

回答 1 投票 0

如何通过链pandoc-> sphinx将Word文档转换为html文件并保留文档代码示例的选项卡

我想从有关python编程的word文档中创建一个HTML站点。我使用链字文档-> [pandoc]-> rst文件-> [sphinx]-> html站点。除了...

ms-word python-sphinx pandoc restructuredtext

回答 1 投票 -1

使用docutils解析和写入RST

是否有任何作家可以输出reStructuredText？我以为“空”作家可能是出于这个目的，但它没有产生任何输出。我的用例是解析现有的RST文件，...

python restructuredtext docutils

回答 1 投票 0

如何使用Sphinx和RST链接类似键入的嵌套类和其他url

使用intersphinx和autodoc，具有：：param存储：对象数组：type存储：list [dict [str，int]]将导致类似以下条目：stores（list [dict [str，int]]）-数组对象。是否有...

python python-3.x python-sphinx restructuredtext

回答 1 投票 0

如何在Sphinx中创建不带标题的框式文本？

[Sphinx中有多个指令可以创建一个框式文本，例如.. note ::或.. topic ::，但它们都包含标题。是否可以创建没有标题的框式文本？

python-sphinx restructuredtext

回答 1 投票 0

如何从Python文档字符串在Sphinx文档中显示图像？

Python文档字符串图像嵌入Python文档字符串中，我有一个reStructuredText指令来显示图像：.. image :: ./images/code_quality.png除了图像以外，我还有一个小图标和一个路径：...] >

python python-sphinx restructuredtext docstring

回答 1 投票 1

如何防止狮身人面像使网址成为超链接？

在我的文档中，我偶尔会使用“垃圾”网址作为示例，并且不希望它们成为无处可链接的超链接。是否有任何语法可以使这些URL不再是超链接？

python-sphinx restructuredtext

回答 2 投票 10

在RST中包含任意文件

DocUtils include指令允许将任意文本包含到RST文档中。问题是实现限制了指定的文件与...

restructuredtext docutils

回答 1 投票 0

RST条件指令在使用标准语法时不起作用

我已经在我的Makefile中定义了一个条件标签，因此我可以使用ONLY指令有条件地删除文本块。 Makefile条目：... set BUILDDIR = _build sphinx-build -t internal ... ...

python-sphinx restructuredtext

回答 1 投票 0

在sphinx doc中运行的doctest

我正在尝试运行用我的第一个文档编写的doctest。但是我不知道如何运行它。我写了以下内容：.. doctest :: >>> 43 + 1 45然后我这样做：$ make html但doc是...

python-sphinx restructuredtext doctest

回答 1 投票 0

非索引方法的本地页面链接

我正在使用sphinx来记录C ++项目，其中有许多页面记录了一个类。在这些方法中，我对类方法使用了：noindex :，因为否则它们会使整个项目变得混乱...

c++ python-sphinx restructuredtext

回答 1 投票 0

[reStructuredText中的链接中的文本格式

您如何格式化reStructuredText中指定链接内的文本？具体来说，我希望从我的第一个脚本中生成以下HTML： documentation <http://docs.python.org/library/optparse.html>\

python-sphinx restructuredtext

回答 4 投票 71

使用Python Sphinx引用长名称

我正在为我的Python模块编写文档（使用Sphinx和reST），我发现当交叉引用其他Python对象（模块，类，函数等）时，完整的对象名就结束了...] >

python python-sphinx restructuredtext

回答 4 投票 10

如何向Sphinx文档添加自定义页脚？（reStructuredText）

[如果我有一些文档，例如Galleria的文档，如何设置它，以便当我运行make html命令时，它将在每个页面上添加自定义页脚？我看到我可以...

linux unix makefile restructuredtext python-sphinx

回答 1 投票 24

有关为Django应用程序编写文档的入门[关闭]

我想为我的一个基于django的项目编写一个文档。我发现django人为此使用了reStructureText和Spinx。我有以下查询。我如何开始...

python django documentation python-sphinx restructuredtext

回答 1 投票 4

restructuredtext 相关问题

最新问题