有没有人知道按文件名的降序订购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对我有用.
我怎么设置它？
我需要为每个模块创建一个sphinx项目,
每个模块共享一些常见的rsts,如公司信息,许可证等.
我的项目树是这样的:
./conf.py
./index.rst
./intro.rst
./about.rst
./device1/conf.py
./device1/index.rst
我在./device1/index.rst中写这个,但它不起作用,我怎么能导入父rst文件？
.. toctree::
:maxdepth: 1
../intro
../about
我正在尝试使用Sphinx来记录项目,但我无法弄清楚如何使用intersphinx.我用这行:
:py:meth:`math.sin`
添加链接,但在输出中,它显示为粗体,而不是链接.虽然该行不起作用,但以下两者都有效:
:py:meth:`dict.items`
:py:class:`zipfile.ZipFile`
我在conf.py文件中的intersphinx_mapping值是:
intersphinx_mapping = {'python':('http://docs.python.org/2.7', None)}
我们在Linux/OSX python环境中使用Sphinx作为文档,但我们在Windows上有人希望能够获得一个可以编辑和构建Sphinx文档的环境.
是否可以在Windows上设置Sphinx？我猜测困难的部分是安装python环境和所有依赖项,但我在Windows上有0次python经验,所以有人可能能够指出我一种直接的方式继续.
我有一个项目,我使用epydoc记录.现在我正在尝试切换到狮身人面像.我为epydocs格式化了所有文档字符串,使用B {},L {}等进行粗体,链接等,并使用@ param,@ return,@ raise等来解释输入,输出,异常等.
所以现在我转向sphinx它失去了所有这些功能.有没有一种自动方式将为epydocs格式化的文档字符串转换为为sphinx格式化的文档字符串？
我正在尝试使用Sphinx为我的项目生成文档,但输出文档不包含任何类.我究竟做错了什么？以下是我用来生成文档的命令:
> ls
Aplikacja.py* Baza.py doc/ EkranLogowania.py EkranRejestracji.py InterfejsWWW.py RequestHandler.py _static/ util.py
BazaLoginow.py BladWalidiacji.py EkranBledu.py EkranMenuGlownego.py GodzinyZajec.py Makefile res/ _templates/ Zajecia.py
BazaPlanow.py db/ EkranEdycjiZajec.py EkranPlanu.py HTTPServer.py Plan.py SesjaUzytkownika.py USOSApi.py
> sphinx-quickstart
Welcome to the Sphinx 1.1.3 quickstart utility.
Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).
Enter the root path for documentation.
> Root path for the documentation [.]:
You have two options for placing the build …我正在使用Sphinx编写一个包含大量引用的文档:
.. _human-factor:
The Human Factor
================
...
(see :ref:`human-factor` for details)
编译后的文档包含以下内容:
(详见人体因素)
相反,我希望它的格式如下:
(详见5.1人为因素)
我试图谷歌解决方案,我发现乳胶hyperref包可以做到这一点,但我不知道如何将其添加到Sphinx构建.
我有以下docstring:
def progress_bar(progress, length=20):
'''
Returns a textual progress bar.
>>> progress_bar(0.6)
'[##########--------]'
:param progress: Number between 0 and 1 describes the progress.
:type progress: float
:param length: The length of the progress bar in chars. Default is 20.
:type length: int
:rtype: string
'''
有没有办法告诉sphinx如果可用,将"Default is X"部分添加到参数的描述中？
我使用scale指令在重组文本中有一个数字,如下所示:
.. figure:: images/my_image.svg
:scale: 150 %
在sphinx的HTML输出中,图像完全正常,除了它没有缩放.(svg图像有宽度和高度信息和viewBox)
奇怪的是,与png图形相比,<img>HTML文件中的标签不包含图像的宽度和高度属性(hm,由于某种原因,sphinx不能确定svg的宽度和高度？).
这是什么原因？sphinx是否支持:scale:svg数字的指令？