使用“from x import *”记录文件
sphinx 的 .. automodule:: 和其他自动功能可以用于记录包含 from x import * 语句的模块,而不包含来自导入模块的所有文档吗? 编辑: 根据 mzjn 的…
csv-table 引用为表编号而不是表名称
我正在制作一个包含许多表格的文档。但是,我知道如何在文本中引用它们的唯一方法是使用 :ref:'my_table' 并将整个表名称“我的表的长标题”放入文本…
通过 :ref:? 从 ReST 文档中提取文本块
我有一些 reStructuredText 文档。我想在在线帮助中使用其中的片段。似乎一种方法是通过引用“剪掉”标记片段,例如 .. _my_boring_section: Introduc…
python sphinx 的重复参数
我是 python-sphinx 的新手,找不到任何解决以下问题的内容: 假设我有一个函数 foo(a,b) 和 bar(a,c) >,这样参数 a 对两个函数具有相同的描述。 是…
以编程方式使用 Sphinx 特定指令解析 .rst 文件
我希望能够在 Python 中解析基于 sphinx 的 rst 以便进一步处理和检查。类似的东西: import sphinx p = sphinx.parse("/path/to/file.rst") do_somet…
获得“平坦” sphinx automodule 的成员输出
我正在使用 Sphinx autodoc 扩展来记录模块,并且我希望在文档输出中获得模块成员的平面列表。 我尝试使用以下内容: .. automodule:: modname :membe…
如何强制Sphinx使用Python 3.x解释器
我尝试为使用 Python 3.x 编写的项目创建文档。 Sphinx 是我想要使用的工具,并且根据官方网站,最新版本1.1.2兼容Python 3.1+。我的操作系统是 Archl…
使用 javascript 代替 Sphinx 的默认目录树
我正在使用 sphinx 自动生成 html 页面。目录真的很长,所以我尝试向 toctree 的 div 添加一个新的 html 类(除其他外),以便我可以使用 JavaScr…
处理 Latex 代码的 django 标记处理器
Django 有一个内置的模板过滤器,可以处理重构的文本。是否可以像 sphinx(文档生成器)处理乳胶代码一样处理乳胶代码,例如使用 .. math:: (a + b)^2…