我正在考虑使用Sphinx/reStructuredText作为文档,它看起来非常有前景,除了表格看起来很痛苦.有编辑可以提供帮助吗？
我是使用狮身人面像的新手.它看起来很不错.我几乎记录了使用autodoc的所有项目,但我想改变一种行为.阅读文档,我已经看到了这个:http://sphinx.pocoo.org/ext/autodoc.html#confval-autodoc_member_order,并希望更改为'bysource'值,重点是,应该放在哪里值？
谢谢,我为我可怜的英语道歉.
更新:我正在使用sphinx 0.6.6
当您键入以下内容时,有没有办法让IPython完全呈现reStructuredText(对于Sphinx)文档字符串:
help foo
要么:
foo?
我觉得超级分心,试图读取IPython的帮助文档时,它显示了原始标记.reST非常适合Sphinx文档,但真正使简单的帮助查找变得混乱.我不能孤身一人......？
谷歌一直没有帮助.
我有一个带有TOC()的Sphinx项目.问题是我想的深度减少了部分,因此它不包括在主TOC发行说明列表(名单太长).index.rst:maxdepth: 21release
似乎可以使用doctree-resolved事件处理程序修改TOC列表,但我无法弄清楚如何在事件处理程序中修改TOC树:
from sphinx import addnodes
def setup(app):
def update_toctree(app, doctree, docname):
if docname != 'index':
return
node = doctree.traverse(addnodes.toctree)[0]
toc = app.env.resolve_toctree(docname, app.builder, node)
# do something with "toc" here
app.connect('doctree-resolved', update_toctree)
我正在尝试仅为所选模块使用autodoc.我创建了一个文件,其中包括:
.. automodule:: some.specific.module
:members:
并且它正确生成.不幸的是,autodoc也在不断尝试解析其他文件(并且由于导入错误而失败).我知道我可以嘲笑一些模块,但我想要一个更好的解决方案 - 阻止sphinx开始看它们.
如何确保仅加载所请求的模块,而不是(例如)test.other.module.
在Pycharm中工作时,我在sphinx中创建的文档的预览模式显示:
System Message: ERROR/3 (<stdin>, line 9)
Unknown directive type "toctree".
..toctree::
:maxdepth: 2
file1
file2
我在conf.py文件中包含了'autodoc'扩展名.当我打开/build/index.html文件时,它工作正常.我的问题是:如何从pycharm预览模式中删除此错误,以便我可以预览我的文档而无需一直打开/build/index.html文件？
有没有人知道按文件名的降序订购toctree的任何选项？在升序的情况下,我们可以使用:glob:选项,如下所示:
.. toctree:
:glob:
2011*
对于应在Sphinx文档中报告的重组文本中的日常注释,这将非常方便.
我正在试图弄清楚如何使用sphinx4或pocketsphinx与英国voxforge模型,但我不能让它工作.我试过阅读doc页面(比如这个http://cmusphinx.sourceforge.net/sphinx4/doc/UsingSphinxTrainModels.html),但它对我没有帮助.
我要的是一个可执行文件,我可以指定要使用的模型和音频文件作为源使用,并具有可执行文件打印出来它是什么在录音的声音说最好的猜测.
我喜欢运气:pocketsphinx_continuous -infile recording.wav 2>/dev/null
但它在转录完整的音频文件之前中止,并且默认模型可以通过几个单词从音频创建可读文本.
我已经编译并测试了sphinx4源程序包中的演示,但是所有示例似乎都只有很少的单词,并且需要一个模型来使用voxforge对我有用.
我怎么设置它？
我在plugins/index.html上有以下页面:
Plugin Development
==================
.. toctree::
:hidden:
basics/index
advanced/index
The Basics
----------
- :doc:`basics/gettingstarted`
- :doc:`basics/resources`
- :doc:`basics/i18n`
Advanced Topics
---------------
- :doc:`advanced/models`
- :doc:`advanced/controllers`
- :doc:`advanced/services`
plugin/basics/index.html和plugins/advanced/index.html包含自己的toctree,它们链接到plugins/index.html中列出的相同子页面.所以我想知道的是,有没有办法只包括那些子toctree,而不是像我一样手动列出子页面？
我意识到我可以从toctree中删除:hidden:标志,但重点是我想将Basic/Advanced主题保存在单独的列表中,并带有自己的标题,介绍段落等.
我正在使用 Sphinx 1.1.3 起草文档。当我一个接一个地插入两个表时，这些表在 HTML 中显示得太近，所以我想在它们之间插入一个空行。我怎么做？