reStructuredText是一种轻量级标记语言,旨在以源格式高度可读。
我正在尝试调整 wiki 页面中图像的大小,但没有任何效果:图像始终以页面的 100% 宽度呈现。 我尝试使用 reStructuredText: .. 图像:: 图像.jpeg :他...
Sphinx 警告:无法从模块 `pythontemplate` 导入 test.test_adder
上下文 创建 root_dir/docs/source/conf.py 并自动为 root_dir/src (和 root_dir/test/)目录(及其子目录)中的每个 .py 文件生成 .rst 文件后,我
下面是一个 reStructuredText 块,它定义了一个“主要部分”和两个小节,每个小节都有一个内容句子。 主要部分 =========== 这是一些主要部分内容...
我正在编写文档,我想包含 pdf 文件或 zip 档案的链接。我如何使用 rst 语言和 sphinx 来实现这一目标? 如果我这样做 这是一个 pdf 文件:`pdf 我正在编写文档,我想包含 pdf 文件或 zip 档案的链接。我如何使用第一种语言和 sphinx 来实现这一目标? 如果我这样做 here is a pdf file : `pdf <doc/mypdf.pdf>`_ 它不起作用,因为在编译期间 sphinx 不复制 doc 目录的内容(我使用 sphinx-quickstart 生成的 makefile)。 相反,使用 image 指令: .. image:: img/plop.png sphinx 会复制构建目录中的 plop.png 图像。如何获得 pdf 或 zip 存档的相同行为? 解决方案是使用 :download:“角色”(有关角色的 sphinx 文档中有详细介绍)。 这是一个简短的示例,假设您在目录 mypdf.pdf 中有一个文件 doc。目录 doc 和您的第一个文件必须位于同一目录中: here is a pdf file :download:`pdf <doc/mypdf.pdf>` 请注意,:download:和文件路径之间不能放置空格。 image指令仅适用于带有 PDF 文件的 HTML。 .. image:: doc/mypdf.pdf 请勿使用它,因为它具有误导性。感谢 G. Milde 的评论。
在 nitpick 模式下运行的 Sphinx 会发出警告,例如“警告:c:未找到类型引用目标:wchar_t”和“警告:c:未找到标识符引用目标:wchar_t”对于
我想将嵌套的 jinja 宏导入到其余文件中并调用它。 所以我们有 main.rst 文件,它导入一个 collection_of_macros.jinja 并且在 collection_of_jinja_macros.jinja 里面是一个...
有没有办法为sphinx表格中的特定行着色? 我尝试使用 .. role:: ,它与 sphinx、restructedtext: set color for a single word 中讨论的 CSS 文件相关。然而...
有没有办法将 CSS 类添加到 Sphinx 生成的 HTML 表中?例如,我想修改以下RST表定义: +--------+ |细胞1 | +--------+ |细胞2 | +--------+ 生成...
Python 文档字符串中段落后的项目符号列表有时不适用于 sphinx 和 numpydoc
使用 numpy 样式记录 Python 模块并使用 sphinx 和 numpydoc 扩展生成 html 文档,我偶然发现了一个有关项目符号列表的错误(或功能?)。 在
有没有办法在重组文本中强制使用特定的项目符号级别? 我在容器中有几个项目符号列表,例如。 .. 容器:: + 外输入 1 - 内部入口1.1 ...
Sphinx 允许使用 |br| 在 HTML 输出中任意放置换行符符号。然而,这不适用于 Latex 或 EPUB。 Sphinx 有什么方法可以在...中指定任意换行符吗?
在我使用 reStructuredText 编写的一份技术文档的其中一个部分中,我想包含一个交互式会话和此输出。 例子: >>> 帮助(模块) 阿斯达斯德
如何处理 ReStructuredText 代码块中不同的缩进?
我正在将旧文档转换为 ReST。该文档具有以下结构: 现在的问题是如何通过 ReST 获得这个。以下不起作用: […]列于下方。 :: d...
我想编写一个文档页面,其中包含以下内容: 标题 ***** 介绍性文字 包含更多详细信息的小节 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 细节 第1节 ========= 第2节 ...
如何简单地防止使用 :scale: 属性的 Sphinx/reStructuredText 中图像的自动链接?文档导出为 HTML,我希望图像不要被点击...
我可以替换 ReStructuredText 中的图形指令吗?
我有一个 .rst 文档,它是使用 wp2rst (使用 pandoc)从 Wordpress 导入的。 在导入过程中,我的所有图像都被翻译成替换的.. image:: 如下: 这是一些文字|
是否可以使用 sphinx 使用 :class: 角色链接到特定 URL?
我正在使用 Sphinx 来记录一个 python 包,该包包装了一个专有 API,据我所知,该 API 并未使用 Sphinx 进行记录。 API 文档提供了有用的信息,但是 URL...
您可以在reStructuredText中显示带有文件名的框架源代码吗?
我正在寻找一种在显示文件名的框中显示源代码的方法。 例如,像这样: 有什么办法可以用 reStructuredText 做到这一点吗?
如何在 reStructuredText 指令选项中指定空格或空字符串?
我想要一个空字符串或一个空格作为标题 - 我该怎么做? .. 代码块:: c :名字:永远 :标题: ”” 为了 (;;) { ; } 这不起作用,我得到一个混乱的错误...