我有一个像这样的三层类结构:classSuper(object):"""Thisclassisdocumented."""classIntermediate(Super):passclassSub(Intermediate):"""Thisisalsodocumented."""我的index.rst文件如下所示:..automodule::mymodule:show-inheritance::inherited-members:Sphinx为我生成了一份不错的API文档。它包括类Super和Sub，并带有适当的注释。它不包括Intermediate，因为它没有注释而且我没有提供und
我正在使用Sphinx来记录一个依赖于wxPython的项目，使用autodocs扩展，以便它会自动从我们的文档字符串生成页面。autodocs扩展会自动在您import的每个模块上运行，这对我们的包来说很好，但是当我们import一个大型外部库时，比如wxPython。因此，我没有让它从wxPython生成所有内容，而是使用unittest.mocklibrarymodule(以前是外部包Mock)。最基本的设置对于wxPython的大部分工作都很好，但我遇到了一种情况，我看不到一个简单的解决方法(可能是因为直到本周我对mock还比较陌生)。目前，我的conf.py文件的末尾有以下内
我有一个包裹:富foo.pybar.py__初始化__.pyfoo.py有一个Foo类。在__init__.py中，我导入类Foo以便用户可以执行以下操作:fromfooimportFooSphinx正确地将Foo记录为foo.foo.Foo，这是正确的，但让用户感到困惑。如何让Sphinx将其记录为foo.Foo？获取与正确模块关联的整体模块文档也很重要。Sphinx文档称为:..module::module.name但是当我在foo.py文件的第一个注释中使用它时，该文档仍然归因于foo.foo。 最佳答案 __module__
我已经为我的项目设置了一个Sphinx文档，并想提取源文件的文档字符串并将它们嵌入到最终文档中。不幸的是，Sphinx不支持源文件的语言(VHDL)。VHDL似乎没有Sphinx域。所以我的思路是这样的:Hook到Sphinx运行并在Sphinx之前执行一些Python代码Python代码从每个源文件(最上面的多行注释block)中提取文本block，并为每个源文件组装一个reST文件，由该注释block和一些其他reST标记组成。所有源文件都列在index.rst中，以生成适当的..toctree::指令。文本提取和转换是在每个源代码目录中递归完成的。所以主要问题是:如何挂接到Spi
我发现Sphinx生成的PDF中的默认代码示例字体太大。我尝试在生成的.tex文件中亲自动手，在代码块上方插入字体大小命令，如\tiny，但这只会使代码块上方的行变小，而不是代码块本身。我不确定还能做什么-我是LaTeX的初学者。 最佳答案 我解决了。Pygments使用\begin{Verbatim}block来表示代码片段，它使用fancyvrb包。documentationIfound(warning:PDF)提到verbatimblock的formatcom选项。Pygments'latexwritersource表示一个实
我正在尝试使用Sphinx为我的项目生成文档，但输出文档不包含我的任何类。我究竟做错了什么？以下是我用来生成文档的命令:>lsAplikacja.py*Baza.pydoc/EkranLogowania.pyEkranRejestracji.pyInterfejsWWW.pyRequestHandler.py_static/util.pyBazaLoginow.pyBladWalidiacji.pyEkranBledu.pyEkranMenuGlownego.pyGodzinyZajec.pyMakefileres/_templates/Zajecia.pyBazaPlanow.pyd
使用autodoc和类似的工具允许人们从源docstrings编译文档。然而，它似乎不允许函数或类文档字符串中的任意ReST部分标题，并产生错误:严重:意外的章节标题。我尝试在没有numpydoc的情况下遵循numpy样式指南进行记录时遇到了类似的问题:unexpectedsectiontitlewithsphinxisnumpytheissue和howdoesnumpyprocessdocstringsintosphinxdocumentationforparameters然而，在这里，我实际上是在编写JavaScript文档，并且只想在docstring中包含任意部分标题和ReST
当您键入以下内容时，有没有办法让IPython完全呈现reStructuredText(对于Sphinx)文档字符串:helpfoo或:foo?我发现在IPython显示原始标记时尝试阅读帮助文档super会分散注意力。reST非常适合Sphinx文档，但确实会使简单的帮助查找变得困惑。我不能一个人处理这个...？Google在这方面没有任何帮助。 最佳答案 我不认为这在IPython中是可能的，但看看Spyder:您可以从IDE中打开IPython控制台。文档字符串呈现为HTML。 关
在我的buildout.cfg文件中我有这样的代码:parts=...sphinxbuilder同一文件中的下一个:eggs=...jinja2markupsafesphinx然后，在文件末尾:[sphinxbuilder]recipe=collective.recipe.sphinxbuildersource=${buildout:directory}/docs-srcbuild=${buildout:directory}/docs我愿意:bin/buildout给出输出(通常:OK):Updatingsphinxbuilder.collective.recipe.sphinxbui
我想使用Sphinx的autosummaryextension和templates从文档字符串递归生成API文档。我想为每个模块、类、方法、属性和函数创建单独的页面。但它根本没有检测到我的模板。事实上，如果我只是从_templates/autosummary/中删除module.rst文件，它会以与以前完全相同的方式呈现整个文件。我关注了thisSOquestion不折不扣。如果您有兴趣，thefullrepositoryisonGitHub.编辑:它似乎确实生成了一个不同的文件，我必须删除docs/_autosummary才能读取新模板。但是，现在它会生成一个带有sparsehead
