问题标签 [docutils]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
python - 覆盖 sphinx/docutils 中的默认字段名称限制
我正在使用sphinx为项目生成 html 文档。我广泛使用字段列表。
生成 html 时,如果标签的长度最多为 14 个字符,则每个标签/值对将呈现为包含两个单元格的单个表格行。
如果一对标签的长度超过 14 个字符,则标签/值将呈现为两个表格行。
我想将换行限制增加到更大的值(例如 40)。我发现限制是由--field-name-limit
docutils 的选项控制的。但是,我找不到如何通过 sphinx 设置这个值。
我docutils.conf
在文档根目录中创建了一个文件,其中包含以下内容:
当我运行 sphinx 时读取该文件。由于该[general]
部分中的值,打印了设置和内部结构。在打印的值中,field_name_limit
打印有 value 40
。尽管如此,我描述的包装仍然出现在 html 输出中。
如何设置 的值以field_name_limit
获得所需的输出?
html - 如何在 HTML 输出中将 rel 属性添加到 docutils sphinx 参考?
我有一个 Sphinx 文档实用程序的简单扩展(我使用的版本是Sphinx-1.1.3-py2.6)。非常喜欢Doug Hellmann 的这个出色的例子。如何在最终的 HTML 中添加rel='bar'属性标签?
似乎有几种方法可以做到这一点,但我找不到一个简单的方法。建议和提示表示赞赏。
参考节点以这种方式创建:
但是,rel='bar'属性会从最终的 HTML 标记中删除。通过源代码搜索让我找到了sphinx/writers/html.py和HTMLTranslator类。这是 visit_reference 方法的一部分:
不处理附加属性。也许它们可以在其他部分被替换。在这方面我找不到任何有用的东西。
所以,我可以:
- 创建一个自定义节点,重新实现参考节点的所有功能。一点点的工作量就够了。
- 覆盖sphinx/writers/html.py中的 *visit_reference* 方法。更快,但在未来的 Sphinx 更新方面很糟糕。
- 事后将带有 jQuery 的 rel 属性添加到链接标记。嗯,也不漂亮。
我确定我错过了明显而优雅的解决方案。
谢谢!
python-sphinx - 在表格内创建目录
我希望能够在表格中生成目录。例如,它应该有边框并且看起来像这样:
我想从以下内容自动生成表格:
输出为 html 和 pdf。
这可以做到吗?还是我必须使用 docutils 解析器或类似的?
docutils - 如何知道docutils的版本号
我发现自己正在搜索服务器正在运行的 docutils 版本。令我惊讶的是,它不像输入带有“--version”标志的任何命令那么简单。我终于通过下面的命令得到了它,但它不是比这更直接吗?
python - 在 reST 中指定锚名称
我正在使用 docutilsrst2html
附带的工具从 reST 创建 HTML。似乎代码已经为id
各个部分分配了属性,这些属性可以用作 URL 中的片段标识符,即用作跳转到页面特定部分的锚点。这些id
值基于部分标题的文本。当我更改该标题的措辞时,标识符也会更改,从而使旧 URL 无效。
有没有办法指定名称用作给定部分的标识符,以便我可以在不使链接失效的情况下编辑标题?如果我自己从自己的脚本中调用 docutils 发布者,会有办法吗?
python - 有没有休息作家?
是否有用于docutil.nodes树的reST Writer?我找不到一个,但也许我错过了一些明显的东西。还是自己写一个微不足道?我想实现从 reST 到 reST 的转换。
python - Django ReStructuredText 中的数学指令
我正在使用 Django 模板重组文本过滤器在我的模板中显示一个 rst 文件。我已经docutils
安装并添加django.contrib.markup
到settings.py
. 显示第一个文本工作正常。
现在,我想在第一个文件中添加一些数学:
测试.rst:
更新:: 我部分解决了这个问题。最初,错误是Unknown directive
. 我试图将数学指令添加到模板中,但后来意识到 docutils 0.10 默认支持数学指令。因此刚刚升级到 docutils-0.10。
但是,现在我看到的是:
如果我这样做rst2html
并在浏览器中检查它,则第一个文件可以正常工作。不同之处在于 html 文件加载 MathJax javascript,而 Django 模板不添加 js 文件。
所以我猜测缺少某些设置或配置...
真的很感激这里的帮助!
python - :概要:在狮身人面像自动模块中不起作用
我正在使用 Sphinx,非常喜欢它,但它不会获取模块概要。没有错误或任何东西,只是简单......什么都没有。这是我试图自动记录的模块:
这是 ReST 索引文件中的 Sphinx 指令:
我从 Sphinx 那里得到了各种其他美妙的东西,所以它对我来说通常不会坏掉。我得到的唯一可疑的事情是:SEVERE: Duplicate ID: "module-CONF"
。一些谷歌搜索让我相信这个错误很“正常”?
python - Sphinx 中的 Autodoc 单模块属性
假设我在 Python 模块中记录了一个变量,如下所示:
我可以在我的 .rst 文件中包含该单个变量的自动文档,而无需拖入模块__doc__
字符串并为此生成文档输出吗?
我努力了
但两者都__doc__
拖入字符串并且不显示some_random_name
.