sphinx-apidoc-Implicit-namespaces
全部标签 我开始尝试使用IPython并行工具,但遇到了一个问题。我启动我的python引擎:ipclusterstart-n3然后下面的代码就可以正常运行了:fromIPython.parallelimportClientdefdop(x):rc=Client()dview=rc[:]dview.block=Truedview.execute('a=5')dview['b']=10ack=dview.apply(lambdax:a+b+x,x)returnackack=dop(27)printack按原样返回[42,42,42]。但是如果我把代码分成不同的文件:复制代码:fromIPython
使用此python2.7.3(或2.7.0)代码,我想更改属性“android:versionCode='2'”的值,它具有命名空间前缀“android”:#!/usr/bin/pythonfromxml.etree.ElementTreeimportElementTree,dumpimportsys,os#Problemhere:ElementTree.register_namespace("android","http://schemas.android.com/apk/res/android")tree=ElementTree()tree.parse("AndroidManife
我正在使用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
我希望某个模块的接口(interface)包含一定数量的函数和类(仅此而已)。我可以在一个文件中实现所有这些,并且很容易获得我想要的界面。但是因为有很多代码,我宁愿把整个东西分成几个文件,比如说mypackage/__init__.pya.pyb.pyc.pyd.py无论如何,为了获得所需的接口(interface),我为从a、b导入所有公共(public)符号的包定义了一个__init__.py文件,c和d:fromaimportfunc_a1,func_a2,ClassA1,ClassA2frombimportfunc_b1,func_b2,ClassB1,ClassB2fromc
我在构建我的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