sphinx-apidoc-Implicit-namespaces
全部标签 我在Python中使用minidom,我希望getElementsByTagName()完全通过标记名匹配元素并忽略任何命名空间。文件由minidom.parseString()解析。可能吗? 最佳答案 getElementsByTagName确实完全通过tagName匹配元素。你的意思是你想纯粹根据localName进行匹配吗?IE。:之后的标签名称部分(如果有)?如果是这样,请使用DOMLevel2Core方法getElementsByTagNameNS:els=document.getElementsByTagNameNS('
我发现Sphinx生成的PDF中的默认代码示例字体太大。我尝试在生成的.tex文件中亲自动手,在代码块上方插入字体大小命令,如\tiny,但这只会使代码块上方的行变小,而不是代码块本身。我不确定还能做什么-我是LaTeX的初学者。 最佳答案 我解决了。Pygments使用\begin{Verbatim}block来表示代码片段,它使用fancyvrb包。documentationIfound(warning:PDF)提到verbatimblock的formatcom选项。Pygments'latexwritersource表示一个实
我正在尝试使用Sphinx为我的项目生成文档,但输出文档不包含我的任何类。我究竟做错了什么?以下是我用来生成文档的命令:>lsAplikacja.py*Baza.pydoc/EkranLogowania.pyEkranRejestracji.pyInterfejsWWW.pyRequestHandler.py_static/util.pyBazaLoginow.pyBladWalidiacji.pyEkranBledu.pyEkranMenuGlownego.pyGodzinyZajec.pyMakefileres/_templates/Zajecia.pyBazaPlanow.pyd
当您键入以下内容时,有没有办法让IPython完全呈现reStructuredText(对于Sphinx)文档字符串:helpfoo或:foo?我发现在IPython显示原始标记时尝试阅读帮助文档super会分散注意力。reST非常适合Sphinx文档,但确实会使简单的帮助查找变得困惑。我不能一个人处理这个...?Google在这方面没有任何帮助。 最佳答案 我不认为这在IPython中是可能的,但看看Spyder:您可以从IDE中打开IPython控制台。文档字符串呈现为HTML。 关
在我的buildout.cfg文件中我有这样的代码:parts=...sphinxbuilder同一文件中的下一个:eggs=...jinja2markupsafesphinx然后,在文件末尾:[sphinxbuilder]recipe=collective.recipe.sphinxbuildersource=${buildout:directory}/docs-srcbuild=${buildout:directory}/docs我愿意:bin/buildout给出输出(通常:OK):Updatingsphinxbuilder.collective.recipe.sphinxbui
我想使用Sphinx的autosummaryextension和templates从文档字符串递归生成API文档。我想为每个模块、类、方法、属性和函数创建单独的页面。但它根本没有检测到我的模板。事实上,如果我只是从_templates/autosummary/中删除module.rst文件,它会以与以前完全相同的方式呈现整个文件。我关注了thisSOquestion不折不扣。如果您有兴趣,thefullrepositoryisonGitHub.编辑:它似乎确实生成了一个不同的文件,我必须删除docs/_autosummary才能读取新模板。但是,现在它会生成一个带有sparsehead
我在Python项目源代码中有一本字典,它描述了默认配置值。字典很长。我希望在Sphinx文档中看到除“查看源代码”之外的其他格式的字典,以便人们可以快速检查默认值。当与Sphinxautodoc一起使用时,Sphinx是否提供选项来将类似字典的变量格式化为人类可读的格式?我目前正在使用..automodule::转储整个模块,我在文档中将字典作为一个长字符串转储(没有换行符,pretty-print,任何东西),基本上不可读。Sphinx是否提供工具来打印出各个源代码变量的值有没有pretty-print? 最佳答案 这可能不是最
我在Python中有很多这样的函数:deffoobar(one,two):"""Myfunction.:paramintone:Myoneargument.:paraminttwo:Mytwoargument.:rtype:Somethingnice."""return100+one+two我需要解析docstring以获得类似这样的字典:{'sdesc':'Myfunction.','params':[('one','Myoneargument.'),('two','Mytwoargument.')],'rtype':'Somethingnice.'}我可以使用sphinx.util
我有一个包含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