restructuredtext 相关问题

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

RST Sphinx xml 自定义扩展

我试图了解如何创建自定义 Sphinx 扩展,该扩展只能在创建 XML 时执行。我想放置一个自定义 RST 指令 ..我的定制:: 并输出后续的 XM...

回答 1 投票 0

Sphinx 角色和指令在笔记本文本块中不起作用

我正在使用 sphinx 为一个项目创建文档,其中包含一组我正在使用 sphinx-gallery 运行的示例,但是在生成的 html 文件、sphinx 角色和指令中(例如 :class:、:meth...

回答 1 投票 0

在第一个文件中,如何提供带有 %APPDATA% 的文件链接,使其独立于用户?

我在第一个文件中有引用本地文件的链接,该文件将位于依赖于用户名的路径中,例如: `我的文件的链接 我在第一个文件中有引用本地文件的链接,该文件将位于依赖于用户名的路径中,例如: `The link to my file <file:///C:\\Users\\USERNAME\\AppData\\Local\\Apps\\myfile.html>`_ 我使用的是 Windows 操作系统,这是可以在资源管理器中使用 %APPDATA% 访问的典型路径。 我想提供类似以下内容的链接: `The link to my file <file:///%APPDATA%\\Apps\\myfile.html>`_ 我对 %APPDATA% 的尝试没有成功。我该怎么办? 编辑:更正了%APPDATA%(在变量末尾添加了%)并在超链接末尾添加了_。但是,这并不能解决真正的问题:浏览器不会解释/扩展 %APPDATA%,因此它会回答“找不到文件”。 简而言之:这是不可能的 解决方法是提供包含 %APPDATA% 的链接,并告诉用户将其复制粘贴到 Windows 资源管理器中。所以首先: To open 'the file', please copy-paste the following link into a Windows Explorer: `file:///%APPDATA%\\Apps\\myfile.html` 详细: 来自 mzdn 和 G. Milde 的评论。 来自相关:superuser.com/q/807835(由@mzjn提供) file:// 出于安全考虑,多年前已被弃用 允许远程站点对您的文件系统进行任何访问的影响。 所以,结果是 HTML 超链接的问题,而不是 reStructuredText。 我想答案是...这是不可能的,请告诉用户将 %APPDATA%\Apps\myfile.html 复制粘贴到 Windows 资源管理器中。

回答 1 投票 0

当我尝试输入括号时(或者当光标位于前面或位于括号上时,VIM 会卡住

我最近在 macOS Catalina 10.15.7 上使用 VIM 编辑第一个文件时遇到了这个奇怪的问题: 当我尝试输入括号时 ( 或者当我的光标试图通过括号时,VIM 会得到结果...

回答 1 投票 0

Sphinx 在文字块中发出神秘错误

在 Sphinx(ReStructuredText 发布系统)中,是否有任何晦涩的规则限制文字块可以包含的内容? 背景:我的文档包含许多跟随双

回答 2 投票 0

reStructuredText/Sphinx 中的引用

我想将引用放入 reStructuredText 文档中的新块中。做到这一点的规范方法是什么?我在这里看到“引用的文字块”,但至少 GitHub 渲染器确实...

回答 1 投票 0

添加选项卡重组文本(第一个)文件

如何将第一个文件中的信息制成表格? 或者,如何保留文本中已插入的空白? 这样,当我将第一个文件(通过 Sphinx)渲染为 HTML 时,表格格式......

回答 1 投票 0

Sphinx:链接到嵌入式二进制文件 (PDF)

我正在使用 sphinx 和 RST 生成一些 HTML 格式的技术文档,但在获取本地 PDF 参考作为超链接时遇到问题。我见过人们使用 :download: 链接到本地 PDF,b...

回答 2 投票 0

RST:如何减小代码块中的字体大小?

我想在我正在使用重构文本准备的演示文稿中包含一个代码块。但代码块中使用的字体很大,无法放入生成的代码框中: 我怎样才能重新...

回答 4 投票 0

Sphinx 抛出一些缩进错误,我不知道如何修复它们

这些是我从 Sphinx 收到的错误: 意外的缩进: [{ “资源”:“/c:/Users/User/Documents/GitHub/MIMIC/mimic/model_simulate/base_model.py”, “主人&qu...

回答 1 投票 0

如果存在超链接,如何翻译Sphinx的'parsed-literal'指令的内容?

问题描述 最近,我尝试使用 gettext 生成器生成的 gettext .po 文件来构建 CMake 文档。但是,我想知道如何翻译 parsed-lite 的内容...

回答 1 投票 0

参考sphinx |版本|作为等宽字体并且没有前导空格

我正在尝试引用狮身人面像|版本|在我的 .rst 文件中的等宽块中(周围没有空格),如下所示...... 您可以使用以下命令安装 foo_project 库: ``pip install -U foo_project==|ve...

回答 1 投票 0

调整 Bitbucket wiki 页面中的图像大小

我正在尝试调整 wiki 页面中图像的大小,但没有任何效果:图像始终以页面的 100% 宽度呈现。 我尝试使用 reStructuredText: .. 图像:: 图像.jpeg :他...

回答 2 投票 0

Sphinx 警告:无法从模块 `pythontemplate` 导入 test.test_adder

上下文 创建 root_dir/docs/source/conf.py 并自动为 root_dir/src (和 root_dir/test/)目录(及其子目录)中的每个 .py 文件生成 .rst 文件后,我

回答 1 投票 0

创建小节后,如何使段落成为父节的一部分?

下面是一个 reStructuredText 块,它定义了一个“主要部分”和两个小节,每个小节都有一个内容句子。 主要部分 =========== 这是一些主要部分内容...

回答 1 投票 0

如何使用sphinx在rst中链接到文件?

我正在编写文档,我想包含 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 的评论。

回答 2 投票 0

标准 C 类型的 Sphinx 警告“未找到参考目标”

在 nitpick 模式下运行的 Sphinx 会发出警告,例如“警告:c:未找到类型引用目标:wchar_t”和“警告:c:未找到标识符引用目标:wchar_t”对于

回答 1 投票 0

如何导入嵌套的 jinja 宏?

我想将嵌套的 jinja 宏导入到其余文件中并调用它。 所以我们有 main.rst 文件,它导入一个 collection_of_macros.jinja 并且在 collection_of_jinja_macros.jinja 里面是一个...

回答 1 投票 0

sphinx,重组文本:颜色单元格/表格行

有没有办法为sphinx表格中的特定行着色? 我尝试使用 .. role:: ,它与 sphinx、restructedtext: set color for a single word 中讨论的 CSS 文件相关。然而...

回答 2 投票 0

将 CSS 类添加到 Sphinx 表格单元格

有没有办法将 CSS 类添加到 Sphinx 生成的 HTML 表中?例如,我想修改以下RST表定义: +--------+ |细胞1 | +--------+ |细胞2 | +--------+ 生成...

回答 1 投票 0

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