我已经安装了Sphinx为了记录我正在研究的一些Python模块和类。虽然标记语言看起来很不错，但我还没有设法自动记录Python代码。基本上，我有以下Python模块:SegLib.py还有一个名为Seg的类。我想在生成的Sphinx文档中显示类和模块的文档字符串，并在其中添加更多格式化文本。我的index.rst看起来像这样:Contents:..toctree:::maxdepth:2chapter1.rst和chapter1.rst:Thisisaheader================Sometext,*italictext*,**boldtext***bulletedl
我正在用Sphinx编写一些文档我只想为HTML文档打印出特定的文本block，而不是为LaTeX文档打印。有些东西告诉我我应该能够用sphinx.ext.ifconfig做到这一点，但我不知道怎么做。有谁知道怎么做？ 最佳答案 不需要扩展。只需使用only指令。(旧链接，来自2010年的原始帖子)https://web.archive.org/web/20100129001557/http://sphinx.pocoo.org/markup/misc.html#including-content-based-on-tags(最新链
我似乎不知道如何使用Sphinx记录异常。我尝试了以下方法:defsome_funct():""":raises:ExceptionType:Somemulti-lineexceptiondescription."""defsome_funct():""":raises:ExceptionType,Somemulti-lineexceptiondescription."""defsome_funct():""":raisesExceptionType:Somemulti-lineexceptiondescription."""defsome_funct():""":raises:Exc
我们有一个用(优秀的)Sphinx记录的多模块项目。我们的设置与describedonthemailinglist不同。.总的来说这个worksgreat!但我们对此有一些疑问:子模块目录将包括索引链接。充其量这些将链接到错误的索引。(在最坏的情况下，这似乎会触发Sphinx中的错误，但我使用的是开发版本，所以这是合理的)。有没有办法只为最顶层的目录树生成索引链接？是否有让Sphinx配置在多个项目之间保持同步的最佳做法？我可以想象围绕fromcommon_configimport*一起破解一些东西，但对其他方法感到好奇。虽然我们正在处理它，但邮件列表帖子中提出的问题(替代符号链接(s
似乎有大量的Python文档工具。我遇到的另一个是epydoc。似乎Sphinx是事实上的标准，因为它用于生成官方Python文档。有人可以帮我整理一下Python文档工具的当前状态吗？ 最佳答案 epydoc和Sphinx是不同类型的工具。它们的相同之处在于:两者都使用ReST通过docutils.两者都非常注重Python风格两者都可以生成HTML和PDF文档他们的关注点不同。Epydoc专注于API(开发人员)文档。使用Epydoc，您可以更快地获得更多结果。你把它指向你的源代码，你就会得到一些东西。这就是我想要的API文档工
使用Sphinx生成文档时，我希望能够生成我的文档的两个版本:一个包含所有内容，一个仅包含一组特定页面。实现这一目标的最佳方法是什么？我可以编写一个构建脚本来移动文件来实现这一点，但如果有一种方法可以告诉sphinx在特定构建期间排除或包含特定文档，那就太好了。 最佳答案 也许我的回答来的有点晚，但我设法通过excludepatternsintheconfigfile用Sphinx做到了这一点.我的文档部分供用户使用，部分供管理员使用。有些页面的文件名包含单词admin，和你一样，我想构建两个版本:一个包含所有内容(管理员文档)，一
这个问题在这里已经有了答案:Howtoaddextrawhitespacebetweensectionheaderandaparagraph(2个回答)关闭4年前。我想使用ReStructuredText在标题和图像之间添加一个空白行(或添加更多空白):====John====..image::_static/john.JPG:alt:John:height:300px:width:400px但我不知道怎么做？ 最佳答案 如下图使用竖线键====John====|..image::_static/john.JPG:alt:John:
我正在使用Sphinx为我的一个项目生成文档。在这个项目中，我在yaml中描述了可用命令的列表。文件，一旦加载，就会生成{command-name:command-description}形式的字典，例如:commands={"copy":"Copythehighlightedtextintheclipboard","paste":"Pastetheclipboardtexttocursorlocation",...}我想知道的是如果sphinx中有方法在makehtml循环中加载yaml文件，在一些reStructuredText格式(例如definitionlist)并包含在我的h
这个问题在这里已经有了答案:Addingacross-referencetoasubheadingoranchorinanotherpage(6个回答)关闭去年。如何在Sphinx文档中创建内部超链接？我正在使用::role:`target`但它不起作用。 最佳答案 交叉引用是使用ref:ref:`label-name`您可以使用以下方式提供标签:.._label-name:见:https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-re
我正在尝试使用Sphinx来记录我的Python类。我使用自动文档这样做:..autoclass::Bus:members:虽然它正确地为我的方法获取文档字符串，但那些被修饰的方法:@checkStaledefopen(self):"""Somedocs."""#Code@checkStale存在defcheckStale(f):@wraps(f)defnewf(self,*args,**kwargs):ifself._stale:raiseExceptionreturnf(self,*args,**kwargs)returnnewf有一个不正确的原型(prototype)，例如ope
