我有一个包含python包的目录，如下所示:--docs/index.rst--docs/...--app/__init__.py--app/foo.py我正在使用sphinx和autodocs来记录应用程序(在python3.3中)。现在，在conf.py(在docs/内)，我有sys.path.insert(0,os.path.abspath('../app'))我cd进入docs/，运行makehtml这给了我SystemError:Parentmodule''notloaded,cannotperformrelativeimport所有有的模块from.fooimportBar
位于http://www.sphinx-doc.org/en/stable/domains.html#cross-referencing-python-objects的Sphinx文档说，:py:func:ReferenceaPythonfunction;dottednamesmaybeused.Theroletextneedsnotincludetrailingparenthesestoenhancereadability;theywillbeaddedautomaticallybySphinxiftheadd_function_parenthesesconfigvalueisTru
我正在使用sphinx用于为项目生成html文档。我广泛使用fieldlists.生成html时，如果标签的长度最多为14个字符，则每个标签/值对将呈现为具有两个单元格的单个表格行。如果一对标签的长度超过14个字符，标签/值将呈现为两个表格行。我想将环绕限制增加到一个更大的值(例如40)。我发现该限制由docutils的--field-name-limit选项控制。但是，我找不到如何通过sphinx设置这个值。我在文档根目录中创建了一个docutils.conf文件，内容如下:[general]dump_settings:1dump_internals:1[html4css1write
我有一个模块应该有一个@property，我通过将一个类设置为模块来解决这个问题。我从这个答案中得到了这个想法:Lazymodulevariables--canitbedone?我希望它可重复且易于使用，所以我为它制作了一个元类。这就像一个魅力。问题是当使用Sphinx生成文档时，属性没有被记录下来。其他一切都按预期记录。我不知道如何解决这个问题，也许这是Sphinx的问题？模块:importsysimporttypesclassClassAsModule(type):def__new__(cls,name,bases,attrs):#Makesurethenameoftheclass
我更喜欢在声明参数的同一行记录每个参数(根据需要)以便应用D.R.Y.如果我有这样的代码:deffoo(flab_nickers,#aseriesofundergarmentstoprocesshas_polka_dots=False,needs_pressing=False#Whetherthelistofgarmentsshouldallbepressed):...如何避免文档字符串中的参数重复，保留参数说明？我想避免:deffoo(flab_nickers,#aseriesofundergarmentstoprocesshas_polka_dots=False,needs_pre
我正在尝试使用Sphinx1.2.1记录我的python包。我对第一个文件的定义包含了一些关于每个模块的描述、使用和为重组文本添加autodoc语法，如下所示。module------..automodule::RAT.REPORTER.bemrstcreator:members::undoc-members::show-inheritance:以上设置为我创建了一个清晰的html构建，没有任何问题。它从所有类及其关联成员等派生文档，但它在html中包含源代码。如何让sphinx不链接各个模块的源码？ 最佳答案 您可以在config
我想要在Sphinx,reStructuredTextshow/hidecodesnippets中提及的相同功能.但是该帖子没有共享代码。 最佳答案 SQLAlchemy文档SQLAlchemy文档使用特殊扩展名(https://bitbucket.org/zzzeek/zzzeeksphinx/)。文档源包含带有自定义选项和标记的标记，如本例所示:..sourcecode::python+sql{sql}>>>engine.execute("select1").scalar()select1(){stop}1这是由特殊的Pygme
我在构建我的Sphinx用户指南时遇到了问题。我想通过一个包含章节标题和概述的主登录页面(index.rst)来形成一个章节，然后将不同的子部分包含在不同的文件(part1.rst,part2.rst)中。我正在尝试使用“toctree”来插入单独的小节，但我遇到了一个嵌套问题，我的toctree被吸进了我的概述部分。(注意:我没有使用..include::指令，因为我希望显示在不同网页上的子部分按顺序链接。我还希望结构正确，以便它们在pdf中很好地布局UG的渲染版本)。index.rstChapter3===============================Overview--
我希望增加我的一个库中的文档。我一直在使用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
