我希望增加我的一个库中的文档。我一直在使用sphinx来帮助构建文档，最近开始探索autodoc扩展。似乎在大多数专业文档中，每个类文档页面都有一个所有文档化方法的列表，顶部有链接。或者，换句话说，顶部的目录树带有指向每个更深入的方法文档的超链接。有没有办法为使用autodoc记录的每个类自动创建此toctree？ 最佳答案 在你的conf.py文件中为sphinx添加extensions=['sphinx.ext.autosummary',]#NOTE:Don'toverwriteyouroldextensionlist!Just
我有一个sphinx文档，当我包含以下几行时:..currentmodule::myMod..autosummary::MyClass出现以下错误ERROR:Unknowndirectivetype"autosummary".然而，autosummary从0.6版本开始可用，我使用Sphinx1.1.3。什么可能导致问题？谢谢!编辑:为了更清楚一点，我说的是python-sphinx，文档工具。 最佳答案 sphinx.ext.autosummary是Sphinxextension.为了使用扩展，您必须将其名称添加到extensio
假设我有以下记录在Numpydocstyle中的函数,并且文档是使用Sphinx自动生成的autofunctiondirective:deffoo(x,y,_hidden_argument=None):"""Fooabar.Parameters----------x:strThefirstargumenttofoo.y:strThesecondargumenttofoo.Returns-------Thebarredfoo."""if_hidden_argument:_end_users_shouldnt_call_this_function(x,y)returnx+y我不想将隐藏参数
假设我有以下记录在Numpydocstyle中的函数,并且文档是使用Sphinx自动生成的autofunctiondirective:deffoo(x,y,_hidden_argument=None):"""Fooabar.Parameters----------x:strThefirstargumenttofoo.y:strThesecondargumenttofoo.Returns-------Thebarredfoo."""if_hidden_argument:_end_users_shouldnt_call_this_function(x,y)returnx+y我不想将隐藏参数
我目前正在记录用Python编写的restAPI。该项目的所有文档都是使用Sphinx创建的，对于RESTAPI，我想创建一些特殊指令。例如，假设我定义了这个资源:@resource("/user/",method="GET")defuser_details(email):"""Returnsdetailedinformationaboutauseraccount.:resourceGET:/user/:query_parama_param:Somekindofqueryparam."""#Dostuffandreturnuserdetails这基本上就是文档当前的样子。我希望能够为S
我目前正在记录用Python编写的restAPI。该项目的所有文档都是使用Sphinx创建的，对于RESTAPI，我想创建一些特殊指令。例如，假设我定义了这个资源:@resource("/user/",method="GET")defuser_details(email):"""Returnsdetailedinformationaboutauseraccount.:resourceGET:/user/:query_parama_param:Somekindofqueryparam."""#Dostuffandreturnuserdetails这基本上就是文档当前的样子。我希望能够为S
我最近尝试使用sphinx-apidoc来自Sphinx帮助从Python项目的API生成Sphinx特定的reStructuredText。但是，我得到的结果是:有人知道我是否可以自定义sphinx-api用于输出的模板吗？具体来说，我想:删除所有“子模块”、“子包”和“模块内容”标题，以及让我的__init__.py文件中的docstring的结果直接显示在包下面，这样如果我单击包名称，我首先看到的是包文档。目前，该文档位于每个包部分末尾的稍微奇怪的“模块内容”标题下。我认为“子模块”和“子包”标题是多余的，因为包/模块的正常标题是“xxx.yyy包”和“xxx.yyy.zzz模块
我最近尝试使用sphinx-apidoc来自Sphinx帮助从Python项目的API生成Sphinx特定的reStructuredText。但是，我得到的结果是:有人知道我是否可以自定义sphinx-api用于输出的模板吗？具体来说，我想:删除所有“子模块”、“子包”和“模块内容”标题，以及让我的__init__.py文件中的docstring的结果直接显示在包下面，这样如果我单击包名称，我首先看到的是包文档。目前，该文档位于每个包部分末尾的稍微奇怪的“模块内容”标题下。我认为“子模块”和“子包”标题是多余的，因为包/模块的正常标题是“xxx.yyy包”和“xxx.yyy.zzz模块
从文档来看，双反引号似乎用于文字，而当有代码文本要解释时使用单反引号。这将引导我为下面的方法f()编写文档字符串:classA(B):deff(arg1,arg2):returnB(arg1+arg2+self.index)作为:Takestwoarguments,``arg1`and``arg2``,whichareassumedtobeobjectsoftype(orduck-type)`NiceClass`,andreturnsanewobjectofclass`B`with`B.something`assignedsomehashof``arg1``and``arg2``.这对
从文档来看，双反引号似乎用于文字，而当有代码文本要解释时使用单反引号。这将引导我为下面的方法f()编写文档字符串:classA(B):deff(arg1,arg2):returnB(arg1+arg2+self.index)作为:Takestwoarguments,``arg1`and``arg2``,whichareassumedtobeobjectsoftype(orduck-type)`NiceClass`,andreturnsanewobjectofclass`B`with`B.something`assignedsomehashof``arg1``and``arg2``.这对
