这是我们安装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
当我使用Sphinxautodoc来记录一个类时，总是会报告属性的值(正如它所说的那样here，在#437下)但总是“=None”Attribute=NoneSomeDocumentation我把它包括在内..autoclass::core.SomeClass:members:我的代码看起来像classSomeClass(object):def__init__(self):self.attribute="value"#:SomeDocumentation有没有办法让“=None”报告真实值，或者让它消失？ 最佳答案 会有一个:ann
Sphinx有一个名为automethod的功能，它可以从方法的文档字符串中提取文档并将其嵌入到文档中。但它不仅嵌入了文档字符串，还嵌入了方法签名(名称+参数)。如何仅嵌入文档字符串(不包括方法签名)？引用:http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html 最佳答案 我想你要找的是:fromsphinx.extimportautodocclassDocsonlyMethodDocumenter(autodoc.MethodDocumenter):def
我正在使用Sphinx的autodoc插件来自动记录一组模块。我有一个接受*args的函数，我想覆盖文档以显示更好的funcname(arg1[,arg2[,...]])Pythonstdlib文档使用的样式。是否可以覆盖特定函数的autodoc输出？ 最佳答案 可以使用autofunction覆盖签名:..automodule::yourmodule:members::exclude-members:funcname..autofunction::funcname(arg1[,arg2[,...]])但是，具有覆盖签名的函数不会与
我正在用Sphinx记录一个类，只是想跳过其中一个类成员:classStatusUpdateAdapter(logging.LoggerAdapter):""""""def__init__(self,status_update_func,logger,extra={}):""""""passdeflog(self,*args,**kwargs):pass如何使sphinx不记录日志成员？如果可能，我想在StatusUpdateAdapter或日志文档字符串中执行此操作。 最佳答案 现在(从0.6版开始)您可以使用:exclude-m
