python-sphinx

python-sphinx

文章 0 浏览 4

使用 Sphinx 文档,如何为 HTML 构建指定 png 图像格式,为 Latex/PDF 构建指定 pdf 图像格式?

使用 sphinx 文档生成器,我尝试使用 .png 图像来构建文档的 HTML,然后我希望将 .svg 图像用于 PDF/LATEX 构建。 有人知道如何将部分“标记”为“仅 …

乜一 2024-11-17 05:31:55 4 0

组合来自多个子项目的 Sphinx 文档:处理索引、同步配置等

我们有一个用(优秀的)Sphinx 记录的多模块项目。我们的设置与邮件列表中描述的设置没有什么不同。总的来说,这个效果很好!但我们对此有一些疑问: …

宫墨修音 2024-11-15 11:57:19 3 0

类似于 wiki 的环境中的 Python 文档(具有一些 autodoc 功能)

Closed. This question is seeking recommendations for software libraries, tutorials, tools, books, or other off-site resources. It does not …

八巷 2024-11-14 15:48:43 3 0

在Sphinx文档中,是否可以使用模块名称来指定要包含的代码示例?

我想在我的 sphinx 文档中包含一个代码示例。 但是,我不想通过文件的路径来引用该文件, 但宁愿通过其模块名称来指定它。 也就是说,不要按照此处指…

柳絮泡泡 2024-11-14 02:32:50 3 0

如何将 intersphinx 链接放入标准库文档中的任意方法?

我正在尝试使用 Sphinx 来记录项目,但我不知道如何使用 狮身人面像。我使用这一行: :py:meth:`math.sin` 添加链接,但在输出中,它显示为粗体,而不…

网白 2024-11-09 21:02:31 4 0

Sphinx,最佳实践

我刚刚开始使用 Sphinx 工具为我的代码生成文档。但我有点困惑,因为它并不像我想象的那么容易。我使用以下命令创建 Sphinx 文档: sphinx-quickstart…

剩余の解释 2024-11-09 04:52:31 2 0

python sphinx线长自动修正

通常,与 sphinx 相关的最佳实践要求您必须将行长度限制为少于 80 个字符。 所以我想要一种方法来自动将行长度限制为少于 80 个字符(没有连字符),…

篱下浅笙歌 2024-11-09 04:44:48 4 0

将外部文档包含到 Sphinx 项目中

我们在 SVN 中使用 Sphinx 维护了相当大的文档。 作为生成输出的一部分,我们希望包含相关 Python 模块的发行说明作为主要内容(而不是超链接!)。外…

西瑶 2024-11-08 18:32:37 3 0

Sphinx:自动标记标题?

在Sphinx中,是否可以自动定义标题标签?我发现我的文档最终看起来很像这样: .._doing stuff: Doing Stuff ----------- You might also want :ref:`o…

星星的軌跡 2024-11-05 01:18:24 4 0

使用 Sphinx 生成 S5 演示文稿

有没有办法使用 Sphinx 1.0 直接从 Sphinx 项目生成 S5 演示文稿。 7? 我在 Sphinx 中发现了对内置 S5 构建器的多个引用,但除了 docutils 中的相关…

沦落红尘 2024-11-04 13:50:22 4 0

Sphinx PDF 输出:python 源代码中的撇号被右单引号替换

我使用 文档 作为 PDF 输出a href="https://www.sphinx-doc.org" rel="nofollow noreferrer">Sphinx。一切都很好,除了当 python 源代码输出时,然后…

时光病人 2024-11-03 01:45:42 5 0

如何使用 Sphinx 的 autodoc 来记录类的 __init__(self) 方法?

默认情况下,Sphinx 不会为 __init__(self) 生成文档。我已尝试以下操作: .. automodule:: mymodule :members: 并且 ..autoclass:: MyClass :members…

魂ガ小子 2024-10-31 12:38:06 5 0

当源文件更改时自动构建 Sphinx 文档

我正在使用 Sphinx 来记录我的一个项目,并且我喜欢在浏览器中预览我的更改。我希望能够将一些更改保存到 .rst 文件中,并能够立即刷新浏览器并查看更…

魂归处 2024-10-30 13:02:55 5 0

同时使用多个狮身人面像主题

我想在 Sphinx 中使用多个主题 - 以便一个页面有一个主题,第二个页面有第二个主题。在我看来,一次只能设置一个主题 - 这是真的吗? 非常感谢, 内德…

千柳 2024-10-27 17:42:09 2 0

是否可以覆盖 Sphinx autodoc 的特定功能?

我正在使用 Sphinx 的 autodoc 插件自动记录一组模块。我有一个接受 *args 的函数,我想重写文档以显示稍微好一点的 funcname(arg1[, arg2[, ...]]) P…

枕梦 2024-10-24 03:34:30 5 0
更多

推荐作者

游缘惊梦

文章 0 评论 0

小兔几

文章 0 评论 0

Glik

文章 0 评论 0

生生漫

文章 0 评论 0

Luxian

文章 0 评论 0

Champion-Ming

文章 0 评论 0

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