restructuredtext相关内容

在Sphinx中生成外部链接

我想链接到我的Sphinx文档中的一些URL: blah 我在文档中找到了类似的东西:http://sphinx-doc.org/ext/extlinks.html--但按照惯例,它更像是用链接替换自定义语法。相反,我只想生成指向外部Web资源的链接。 推荐答案 在reStructuredText documenta ..
发布时间:2022-08-14 22:01:04 其他开发

更改PyCharm中的文件类型关联

我在PyCharm中有一个文件,它过去只是一个.txt文件。 现在,我想要使用.rst(ReStrufredText)。 我知道当我第一次打开没有结尾的文件时,PyCharm会询问我它是什么类型的文件,因此应该如何解释语法。 我是否可以以某种方式再次打开该对话框,或者是否可以以其他方式更改关联? 推荐答案 其实,@CrazyCoder是对的: 如果您不小心标记错了文件,则P ..
发布时间:2022-06-23 21:47:23 Python

转义索引指令中的特殊字符

我正在使用Sphinx为Prolog系统实现生成文档。PROLOG语言包括分别由复合术语(',')/2和(;)/2表示的合取和析取控制结构。 但由于逗号和分号的存在,以下索引指令不会生成正确的条目: .. index:: (',')/2 .. index:: (;)/2 到目前为止,我一直无法找到字符转义的解决方案。我在Prolog!/0控制构造中也遇到了同样的问题,但我通过编写 ..
发布时间:2022-04-21 17:06:36 其他开发

为具有特定标题的通用狮身人面像警告定义标记

我正在使用Sphinx为一个Python程序生成HTML文档。 我想使用泛型admonition指令(参见http://docutils.sourceforge.net/docs/ref/rst/directives.html#generic-admonition),并以我可以定义的方式对其进行标记,例如,类似于使用note指令生成的内容,即加了方框,但使用不同的颜色(大多数警告没有特别的样式, ..
发布时间:2022-04-21 09:04:01 其他开发

如何用狮身人面像制作2根柱子

我要在我的文档上创建多个栏。 在全球范围内,我想做一些类似于this homepage的事情,其中有3个栏:一个是当前版本,一个是新闻和更新,以及基本信息。 当我在Google上搜索Sphinx中的多个列时,我发现将列表拆分为2列不是我的情况 在Wiki上,我发现有多个列的唯一内容是表,但我认为这不适用于这里? 在使用Sphinx的rst文件中可以做到这一点吗? 非常 ..
发布时间:2022-04-20 22:01:03 Python

如何添加目录树条目?

我正在尝试开始使用Sphinx来记录Python,但我似乎遗漏了一些非常基本的入门步骤。 我正在按照http://www.sphinx-doc.org/en/stable/tutorial.html进行操作,并已安装并配置(尽可能使用默认设置)该工具。 问题是我无法将另一个RST文件链接到索引。我的索引文件如下: Welcome to FirstProject's documen ..
发布时间:2022-04-20 21:53:04 Python

使用 LaTeX 在 reStructuredText 中进行数学运算

我想在大学课堂上使用轻量级标记语言做笔记. 我选择的编辑器是 gedit,我发现 reStructuredText Tools for Gedit,其中将运行 reStructuredText 处理器并在 gedit 的窗格中呈现 HTML.这很棒,已经完成了 80%. 但是对于我的许多课程,我需要在笔记中包含数学方程式或希腊字符.虽然我对 LaTeX 不是很熟悉,但我的理解是它具有这 ..
发布时间:2022-01-24 12:42:28 其他开发

在 sphinx 中创建一个与“make latexpdf"一起使用的角色(字体颜色)

我习惯写 Rest 文档,而我从来没有使用过 LaTex. 我想做的是创建一些字体颜色角色,我可以添加内联文本(例如:red:this text is red)html和latexpdf编译. 我发现了一个类似的问题这里,但我无法重现它. 我认为 magic 将完成更改 conf.py 文件,但我不知道如何. 另外,在latexpdf编译过程中,在_build/latex目 ..
发布时间:2022-01-24 12:40:42 其他开发

Sphinx 中的条件目录树

我想做一个文档的多个版本,这些版本在包含的部分中有所不同.为了实现这一点,我通常会使用 only 指令或 ifconfig 扩展.但是,我不能将其中任何一个与 toctree 指令结合使用.p> 我基本上想要的是这样的: .. toctree:::最大深度:2介绍字符串数据类型数字.. 只有:: 大学复杂的 有没有办法做到这一点? 解决方案 如果你有目录层次结构,我之前的答案会失败, ..

PyCharm 更改文件类型关联

我在 PyCharm 中有一个文件,它曾经只是一个 .txt 文件.现在我想使用 .rst (reStructuredText). 我知道,当我第一次打开一个没有结尾的文件时,PyCharm 会询问我它是什么类型的文件以及应该如何解释语法. 我可以以某种方式再次打开该对话框,还是可以通过其他方式更改关联? 解决方案 其实@CrazyCoder 是对的:如果您不小心错误地标记了文 ..
发布时间:2022-01-08 09:24:55 Python

我如何在 Sphinx 中交叉引用由 autodoc 生成的函数?

我正在使用 Sphinx autodoc 功能根据我的 Python 库的文档字符串生成文档. 交叉引用的语法在这里 标签必须位于该部分之前,以便可以从文档的其他区域引用该部分. 我拥有的是我的一个课程的 .rst (ReStructeredText) 文件.它使用 .. autoclass:: 类名:成员: 为类生成文档. 我的问题是,如何从文档中的另一个 .rst ..
发布时间:2021-12-23 08:58:10 Python

将一个版本合并到一个 JAR 文件中的最简单方法

是否有工具或脚本可以轻松合并一堆 JAR 文件成一个 JAR 文件?一个好处是可以轻松设置主文件清单并使其可执行. 具体案例是Java重组文本工具.我想用类似的东西运行它: java -jar rst.jar 据我所知,它没有依赖项,这表明它不应该是一个简单的单文件工具,但下载的 ZIP 文件包含很多库. 0 11-30-07 10:01 jrst-0.8.1/922 11- ..
发布时间:2021-11-25 15:30:52 Java开发