我只想在我的Sphinx文档中包含特定函数的文档字符串。然而，似乎没有选项可以使用http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html仅显示这些细节而不关联类和函数定义。我已尝试创建一个类，如Show*only*docstringinSphinxdocumentation?中所述但我不确定这如何适应模板。我也尝试过autodoc-process-docstring事件处理程序，但没有成功。因此，而不是我的文档显示(如当前所示):classmodule.MyClass(param)Thisistheclassd
我有一个使用epydoc记录的项目。现在我正在尝试切换到狮身人面像。我为epydocs格式化了我所有的文档字符串，使用B{}、L{}等来加粗、链接等，并使用@param、@return、@raise等来解释输入、输出、异常等。所以现在我改用sphinx，它失去了所有这些功能。是否有一种自动方法可以将针对epydocs格式化的文档字符串转换为针对sphinx格式化的文档字符串？ 最佳答案 为了扩展KevinHorn的回答，可以在autodoc-process-docstring触发的事件处理程序中即时翻译文档字符串。事件。下面是一个小
我正在为我的Python模块(使用Sphinx和reST)编写文档，我发现当交叉引用其他Python对象(模块、类、函数等)时，完整的对象名称最终变得令人难以置信长。它通常超过80个字符，我想不惜一切代价避免这种情况。这是一个例子:defexampleFunction():'''Hereisanexampledocstringreferencinganother:class:`module1.module2.module3.module4.module5.ReallyLongExampleClassName`'''问题是，在为ReallyLongExampleClassName类创建文
我正在用Python编写一些数学代码并使用Sphinx生成文档。我知道Sphinx可以处理Python文档字符串中的LaTeX代码；见https://www.sphinx-doc.org/en/master/usage/extensions/math.html#module-sphinx.ext.mathbase.如何创建LaTeX宏，例如\newcommand{\cG}{\mathcal{G}}，以在Python文档字符串中使用？ 最佳答案 如果您使用MathJax，这里有一个可能的解决方案。我仍在寻找更好的解决方案，但如果您需要
这是我们安装Sphinx的过程。>chocoinstallpython-y-f>pipinstallsphinx我们知道sphinx安装是因为以下输出。>pipshowsphinx---Metadata-Version:2.0Name:SphinxVersion:1.4.3Summary:PythondocumentationgeneratorHome-page:http://sphinx-doc.org/Author:GeorgBrandlAuthor-email:georg@python.orgLicense:BSDLocation:c:\programdata\chocolate
我们有一个Sphinx配置，可以为我们的整个代码库生成大量HTML文档。有时，我正在处理一个文件，我只想查看该文件的HTML输出，以确保语法正确，而无需运行整个套件。我寻找可以在终端中运行的最简单的命令来在这个文件上运行sphinx，我确信信息在那里，但我没有看到它。 最佳答案 Sphinx处理reST文件(不是直接处理Python文件)。这些文件可能包含对Python模块的引用(当您使用autodoc时)。我的经验是，如果自上次完整输出构建以来仅修改了一个Python模块，Sphinx不会重新生成所有内容；仅处理“引入”该特定Py
我目前正在用autodoc记录整个模块.但是，我在模块级别定义了几个包含长列表或字典的变量。它们与值一起包含在文档中，并且值未格式化，因此看起来像10行乱七八糟的东西。我想要的是包含这些变量的文档字符串，但省略值或至少格式化得很好。我试图从automodule指令中排除变量并像这样添加它:..automodule::foo.bar:members::exclude-members:longstuff..py:data::longstuff这导致仅包含变量名称，而文档字符串和longstuff的值均未出现在文档中。我怎样才能在保留文档字符串的同时删除值(或将其格式化)？
我正在尝试使用Sphinx的..include::directive将一个文件中的文档包含在另一个文件中，以避免重复文档的源文本。我包含的部分位于configuration.rst(它是配置设置引用文档的一部分)，它包含一些用于交叉引用每个配置设置的标签:..start_config-authorization.._ckan.auth.anon_create_dataset:ckan.auth.anon_create_dataset^^^^^^^^^^^^^^^^^^^^^^^^^^^^^Example::ckan.auth.anon_create_dataset=FalseDefau
我正在使用Sphinx记录我的项目。我启用了sphinx.ext.coverage我的配置文件中的扩展名。我正在运行以下命令来生成覆盖率报告(按照thisanswer的指导:bash-3.2$sphinx-build-v-bcoverage._build/coverage/Makingoutputdirectory...RunningSphinxv1.2.3loadingpickledenvironment...notyetcreatedbuilding[coverage]:coverageoverviewupdatingenvironment:10added,0changed,0re
我有一个Sphinx项目，其目录(index.rst)包括:maxdepth:2。问题是我想将release部分的深度减少到1，这样它就不会在主目录中包含发行说明列表(该列表太长)。似乎可以使用doctree-resolved事件处理程序修改TOC列表，但我不知道如何在事件处理程序中修改TOC树:fromsphinximportaddnodesdefsetup(app):defupdate_toctree(app,doctree,docname):ifdocname!='index':returnnode=doctree.traverse(addnodes.toctree)[0]toc
