我想通过reST生成文档，但不想手动编写reST源代码，而是让python脚本执行此操作，然后使用sphinx生成其他格式(HTML、PDF)。假设我有一本二进制格式的电话簿。现在我使用一个python脚本来解析它并生成一个包含所有名称和数字的文档:phone_book=PhonebookParser("somefile.bin")restdoc=restProducer.NewDocument()forentryinphone_book:restdoc.add_section(title=entry.name,body=entry.number)restdoc.write_to_fi

我们使用SVN中的Sphinx维护了相当大的文档。作为生成输出的一部分，我们希望将相关Python模块的发行说明作为主要内容(而不是超链接!)。外部模块的发行说明也在SVN中维护。是否有一些类似Sphinx的方法可以从其他(SVN)来源提取文档的部分内容？好吧，使用SVNexternals是解决问题的一种方法，但也许不是最聪明的方法……还有更好的选择吗？ 最佳答案 我能想到的两个选项是:添加一个svn:externals链接到远程项目(您已经知道)。使用自定义指令扩展Sphinx，以包含来自远程颠覆存储库的文件。我不是Sphinx内

对于一个用reStructuredText编写并使用Sphinx呈现为HTML的编程语言文档项目，我想将我的函数分组到逻辑组中，例如:String(所有字符串函数)、Web(所有与Web相关的函数)、List(任何与做列表处理)等。现在，由于函数可以是多个组的成员，我想以某种方式添加标签，就像您在博客文章中一样。如果有一个Sphinx扩展(或使用Domains的方式)来添加标签，然后为每个标签生成一个引用所有这些功能的页面，所有标签的概述和交叉引用，那将是非常整洁的每个功能页面的底部。这是否可行？如果可行，如何实现？例子:substring=========**substring(**

我正在执行i18n/l10n大型项目文档的任务。该文档是使用现成的Sphinx完成的basicsupportfori18n.我的问题与thisotherquestion的问题类似:事实上，每个pot文件的大部分字符串都是相同的，我希望我的翻译人员不要一遍又一遍地重新输入相同的翻译。我宁愿有一个模板文件。我的问题不是真正的合并文件(这只是一个msgcat*.pot>all.pot)，而是一个事实-在构建文档时域工作一种特定的语言-我必须将all.pot复制并重命名为原始文件名。所以我的解决方法是:生成fileA.pot,fileB.pot将两者合并成all.potcpall.potfil

我写了一个Python模块，包括一个用C编写的子模块:模块本身称为foo，C部分是foo._bar。结构如下:src/foo/__init__.pyfoo/__init__.py导入_bar来扩充它，有用的东西暴露在foo模块中。这在构建时工作正常，但显然不能以未编译的形式工作，因为_bar在构建之前不存在。我想使用Sphinx来记录项目，并使用autodocfoo模块上的扩展。这意味着我需要先构建项目，然后才能构建文档。由于我使用distutils构建，构建的模块最终位于一些可变命名的目录build/lib.linux-ARCH-PYVERSION—这意味着我不能将目录硬编码到Sph

我一直在尝试记录我的MongoEngine基于应用程序，但我在记录我的文档类的属性时遇到了问题。我采用的正确语法如下:classAsset(Document):#:ThisistheURIofthedocumenturi=StringField()我已经尝试了各种方法来记录我发现的这些属性，甚至添加了一个不是MongoEngine字段的属性，只是为了确保这不是问题所在:classAsset(Document):"""Therepresentationofafileuploadedintothedatastore."""#:Thisisatestattribute.foo='bar'""

我一直在构建一个具有许多不同功能的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