我一直在构建一个具有许多不同功能的Python模块。我正在使用Sphinx和readthedocs来提供文档。我取得了不错的进展，但目前我有onemassivepage它提供了我所有功能的文档(按字母顺序排列)。我看过其他项目，每个功能都有一个单独的页面。在查看它们的源代码时，我发现每个都创建了一个单独的.rst文件。我假设这是自动完成的，thispage关于生成autodoc摘要似乎描述了其中的一些内容，但我就是无法理解。sphinx-apidoc有一个选项(-e)可以为每个模块创建一个页面，但我想为每个功能创建一个页面。如何使用Sphinx为每个功能自动生成单独的页面？附加信息要为
我有一个简单的Sphinx扩展如下:fromdocutilsimportnodesfromdocutils.parsers.rstimportdirectivesfromsphinx.util.compatimportDirectiveclasstestnode(nodes.Element):def__init__(self,*args,**kwargs):super(testnode,self).__init__(*args,**kwargs)self['foo']='?'defvisit_testnode_latex(self,node):self.body.append('Tes
您可以像这样在Python文档字符串中指定参数类型:def__init__(self,canvas,segments):"""Classconstructor.:paramcanvas:thePDFcanvasobject:paramsegment:Thelayersegmentstobedrawn.:typecanvas:`canvas.Canvas`:typesegments:listofstr"""...借助Sphinx的自动文档功能，这会生成参数列表，并且每个参数都正确标记了它们的类型。但是我如何使用实例属性来做到这一点呢？像这样classPath(object):""":iv
代码块在PDF输出中看起来很难看(检查引号):我使用1.1.3版的Sphinx，并使用以下命令生成文档:$makelatexpdf此外，从PDF复制代码片段会破坏粘贴时的缩进:@view_config(route_name=’hello’)defhello_world(request):returnResponse(’HelloWorld!’)我希望这样:@view_config(route_name=’hello’)defhello_world(request):returnResponse(’HelloWorld!’)这样会更好:@view_config(route_name='h
我正在尝试用Python记录一个包。目前我有以下目录结构:.└──project├──_build│ ├──doctrees│ └──html│ ├──_sources│ └──_static├──conf.py├──index.rst├──__init__.py├──make.bat├──Makefile├──mod1│ ├──foo.py│ └──__init__.py├──mod2│ ├──bar.py│ └──__init__.py├──_static└──_templates这棵树是sphinx-quickstart启动的结果。在conf.py我取消注释sys
使用Sphinx1.2.3并给出此RST片段:..code-block::xml|version|在conf.py我有:version='1.0.2'您如何确保上述RST片段呈现为:1.0.2这previousquestion表示我们应该使用..parsed-literal::而不是..code-block::，但这不起作用，该问题中引用的链接也不起作用要么工作。我还想保留语法高亮。 最佳答案 您可以使用backslash-escapedwhitespace获得想要的输出:..parsed-literal::\|release|\不
在我写的一些sphinx文档中，我包含了来自辅助文件的代码示例，如下所示:..literalinclude::mymodule.py:pyobject:MyClass:linenos:这个特定的文档是一个教程，其中的类是逐步构建的。我想做的是包括整个类或单个方法，并只强调该部分感兴趣的行。这样可以保留上下文，但有趣的部分一目了然。现在我只引用文本中的行号，这没问题，但远非理想。查看sphinx和pygments的文档和代码，我没有找到一个明显的方法来做到这一点。我不反对在conf.py中修补它们或做一些棘手的事情，但我想知道是否有人解决了这个问题。 最佳答案
我正在尝试将Sphinx搜索引擎与他们的PythonAPI结合使用。安装顺利。但是当我使用他们的PythonAPI时，我没有得到完整的结果集。我只看身份证？但是当我在./bin中使用他们的./search二进制文件时，我得到了整个索引内容。当使用cpp./searchbinary-./searchtest1.document=1,weight=1,group_id=1,date_added=SatSep1107:42:382010,title=2id=1group_id=1group_id2=5date_added=2010-09-1107:42:38title=testonecont
我们使用Sphinx在我们的Linux/OSXpython环境中获取文档，但我们有人在Windows上希望能够获得一个他们可以在其中编辑和构建Sphinx文档的环境。是否可以在Windows上设置Sphinx？我猜最困难的部分是安装python环境和所有依赖项，但我在Windows上使用python的经验为0，因此有人可能会指出我继续进行的直接方法。 最佳答案 用于在Windows上安装python下载Python.运行可执行文件，一切就绪。如果你安装了pip，那么你可以打开命令提示符并输入pipinstall-USphinx如果您
我有一个像这样的三层类结构:classSuper(object):"""Thisclassisdocumented."""classIntermediate(Super):passclassSub(Intermediate):"""Thisisalsodocumented."""我的index.rst文件如下所示:..automodule::mymodule:show-inheritance::inherited-members:Sphinx为我生成了一份不错的API文档。它包括类Super和Sub，并带有适当的注释。它不包括Intermediate，因为它没有注释而且我没有提供und
