python-sphinx

python-sphinx

文章 0 浏览 6

使用“from x import *”记录文件

sphinx 的 .. automodule:: 和其他自动功能可以用于记录包含 from x import * 语句的模块,而不包含来自导入模块的所有文档吗? 编辑: 根据 mzjn 的…

凉城凉梦凉人心 2024-12-22 07:47:47 0 0

csv-table 引用为表编号而不是表名称

我正在制作一个包含许多表格的文档。但是,我知道如何在文本中引用它们的唯一方法是使用 :ref:'my_table' 并将整个表名称“我的表的长标题”放入文本…

白云不回头 2024-12-21 13:42:01 2 0

通过 :ref:? 从 ReST 文档中提取文本块

我有一些 reStructuredText 文档。我想在在线帮助中使用其中的片段。似乎一种方法是通过引用“剪掉”标记片段,例如 .. _my_boring_section: Introduc…

‘画卷フ 2024-12-19 16:50:57 4 0

如何配置 Sphinx 有条件地排除某些页面?

使用 Sphinx 生成文档时,我希望能够生成文档的两个版本:一个包含所有内容,另一个仅包含一组特定的页面。实现这一目标的最佳方法是什么? 我可以编…

倾其所爱 2024-12-18 20:29:51 6 0

python sphinx 的重复参数

我是 python-sphinx 的新手,找不到任何解决以下问题的内容: 假设我有一个函数 foo(a,b) 和 bar(a,c) >,这样参数 a 对两个函数具有相同的描述。 是…

堇年纸鸢 2024-12-18 20:01:51 4 0

如何在节标题和段落之间添加额外的空格

我希望标题和段落之间以及段落之间有更多的空间。我不希望这是一个全局设置,但我想在需要的地方和时间使用它。感谢任何建议。…

回梦 2024-12-17 02:37:04 5 0

如何在sphinx doc中显示和隐藏代码?

我希望在 Sphinx、reStructuredText 显示/隐藏代码片段中提及相同的功能。但该帖子上没有共享代码。…

月亮坠入山谷 2024-12-16 16:56:37 5 0

在 Sphinx reST 中包含机密信息

我在其自己的“copy.rst”文档中有保密文本。如何将其包含在目录树中而不显示出来?…

梦幻之岛 2024-12-16 16:30:44 5 0

Sphinx/reST 没有为文档生成索引

使用ma​​ke html命令生成文档时,索引页始终为空。我需要为此启用任何功能吗?…

关于从前 2024-12-16 13:51:02 4 0

如何在 reStructuredTest/Sphinx 中语法高亮 XML

在 Sphinx/reST 中添加 xml 的建议方法是什么,以便它在生成的文档中正确显示。…

执手闯天涯 2024-12-16 11:42:02 4 0

以编程方式使用 Sphinx 特定指令解析 .rst 文件

我希望能够在 Python 中解析基于 sphinx 的 rst 以便进一步处理和检查。类似的东西: import sphinx p = sphinx.parse("/path/to/file.rst") do_somet…

梦境 2024-12-15 14:21:23 5 0

获得“平坦” sphinx automodule 的成员输出

我正在使用 Sphinx autodoc 扩展来记录模块,并且我希望在文档输出中获得模块成员的平面列表。 我尝试使用以下内容: .. automodule:: modname :membe…

荭秂 2024-12-14 22:43:15 3 0

如何强制Sphinx使用Python 3.x解释器

我尝试为使用 Python 3.x 编写的项目创建文档。 Sphinx 是我想要使用的工具,并且根据官方网站,最新版本1.1.2兼容Python 3.1+。我的操作系统是 Archl…

待天淡蓝洁白时 2024-12-14 01:50:16 4 0

使用 javascript 代替 Sphinx 的默认目录树

我正在使用 sphinx 自动生成 html 页面。目录真的很长,所以我尝试向 toctree 的 div 添加一个新的 html 类(除其他外),以​​便我可以使用 JavaScr…

心是晴朗的。 2024-12-13 17:31:01 7 0

处理 Latex 代码的 django 标记处理器

Django 有一个内置的模板过滤器,可以处理重构的文本。是否可以像 sphinx(文档生成器)处理乳胶代码一样处理乳胶代码,例如使用 .. math:: (a + b)^2…

你怎么这么可爱啊 2024-12-11 15:45:58 8 0
更多

推荐作者

夢野间

文章 0 评论 0

百度③文鱼

文章 0 评论 0

小草泠泠

文章 0 评论 0

zhuwenyan

文章 0 评论 0

weirdo

文章 0 评论 0

坚持沉默

文章 0 评论 0

    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文