使用 Sphinx 文档,如何为 HTML 构建指定 png 图像格式,为 Latex/PDF 构建指定 pdf 图像格式?
使用 sphinx 文档生成器,我尝试使用 .png 图像来构建文档的 HTML,然后我希望将 .svg 图像用于 PDF/LATEX 构建。 有人知道如何将部分“标记”为“仅 …
组合来自多个子项目的 Sphinx 文档:处理索引、同步配置等
我们有一个用(优秀的)Sphinx 记录的多模块项目。我们的设置与邮件列表中描述的设置没有什么不同。总的来说,这个效果很好!但我们对此有一些疑问: …
类似于 wiki 的环境中的 Python 文档(具有一些 autodoc 功能)
Closed. This question is seeking recommendations for software libraries, tutorials, tools, books, or other off-site resources. It does not …
在Sphinx文档中,是否可以使用模块名称来指定要包含的代码示例?
我想在我的 sphinx 文档中包含一个代码示例。 但是,我不想通过文件的路径来引用该文件, 但宁愿通过其模块名称来指定它。 也就是说,不要按照此处指…
如何将 intersphinx 链接放入标准库文档中的任意方法?
我正在尝试使用 Sphinx 来记录项目,但我不知道如何使用 狮身人面像。我使用这一行: :py:meth:`math.sin` 添加链接,但在输出中,它显示为粗体,而不…
将外部文档包含到 Sphinx 项目中
我们在 SVN 中使用 Sphinx 维护了相当大的文档。 作为生成输出的一部分,我们希望包含相关 Python 模块的发行说明作为主要内容(而不是超链接!)。外…
Sphinx:自动标记标题?
在Sphinx中,是否可以自动定义标题标签?我发现我的文档最终看起来很像这样: .._doing stuff: Doing Stuff ----------- You might also want :ref:`o…
使用 Sphinx 生成 S5 演示文稿
有没有办法使用 Sphinx 1.0 直接从 Sphinx 项目生成 S5 演示文稿。 7? 我在 Sphinx 中发现了对内置 S5 构建器的多个引用,但除了 docutils 中的相关…
Sphinx PDF 输出:python 源代码中的撇号被右单引号替换
我使用 文档 作为 PDF 输出a href="https://www.sphinx-doc.org" rel="nofollow noreferrer">Sphinx。一切都很好,除了当 python 源代码输出时,然后…
如何使用 Sphinx 的 autodoc 来记录类的 __init__(self) 方法?
默认情况下,Sphinx 不会为 __init__(self) 生成文档。我已尝试以下操作: .. automodule:: mymodule :members: 并且 ..autoclass:: MyClass :members…
是否可以覆盖 Sphinx autodoc 的特定功能?
我正在使用 Sphinx 的 autodoc 插件自动记录一组模块。我有一个接受 *args 的函数,我想重写文档以显示稍微好一点的 funcname(arg1[, arg2[, ...]]) P…