restructuredtext 相关问题

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

使用javascript代替Sphinx的默认toctree。

我正在使用sphinx来自动生成html页面。目录很长,所以我想在toctree的div中添加一个新的html类(除其他外),这样我就可以使用一个javascript库。...

回答 1 投票 2


自定义(多字)标题为《斯芬克斯训诫》。

我使用Sphinx来发布一个课程。我想创建一个由多个单词组成的标题的自定义训诫(例如 "历史笔记")。我想出了一个肮脏的技巧,在......中使用.admonition-title:after。

回答 1 投票 0

狮身人面像上table-csv内部的reStructuredText替换

我正在尝试替换Sphinx上的table-csv指令加载的文件。我的想法是执行以下操作:.. csv-table :: My CSV Table:header:“ Column 1”,“ Column 2”:file:some / ...

回答 1 投票 0

reStructuredText和词汇术语翻译

我想知道如何翻译(如在i18n中)术语表中的术语。我使用Sphinx 1.1.3,假设我有:..词汇表::术语定义运行make gettext后,我得到了.po文件...

回答 1 投票 2

Sphinx文档中的人类可迭代对象

Sphinx-autodoc展平字典,列表和元组-使长条几乎不可读。也不总是需要漂亮的打印格式,因为与嵌套的容器相比,某些嵌套的容器最好保持扁平化。...

回答 1 投票 1

在toctree中添加self的各个部分

我在获取目录(TOC)以显示文档首页的小节时遇到问题。我的首页上有很多部分,我希望这些是...

回答 1 投票 3

首先列出本地节,在TOC中最后列出链接的页面

假设我具有以下index.rst:一些全局主题===================== .. toctree :::glob:嵌套/索引全局主题介绍------------------------和nested / index.rst:...

回答 1 投票 3

如何使用sphinx-autodoc引用字典?

:data:`〜package._module._DICT_NAME`不起作用; _DICT_NAME就像被引用一样呈现,但是没有超链接。与:obj:相同。不能将其放入函数中。

回答 1 投票 0

为上下文敏感的标记语言编写词法分析器,该语言具有递归结构,例如嵌套列表

我正在Rust中开发一个reStructuredText编译器,并且需要一些有关如何在具有递归结构的语言中构建词汇的建议。例如...

回答 1 投票 2

Sphinx的extlinks扩展名可以配置为显示url吗?

我非常喜欢我可以使用Sphinx extlinks扩展名缩短文本中URL的事实。我也希望在这里和那里也可以在呈现的文档中显示完整的URL,而无需...

回答 1 投票 0

不同文件的标题不匹配

我在Sphinx中有一个非常基本的设置。 TOC如下:.. toctree :::maxdepth:3一二,文件一和二看起来像这样:one.rst #### Part #### *******章*** **** ...

回答 1 投票 2

如何引用以单数形式定义但以复数形式表示的词汇表术语?

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

回答 1 投票 1

在表内部创建目录表

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

回答 1 投票 0

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

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

回答 1 投票 1

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

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

回答 1 投票 4

隐藏toctree中的特定文件?

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

回答 1 投票 3

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

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

回答 1 投票 0

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

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

回答 1 投票 -1

使用docutils解析和写入RST

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

回答 1 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.