以下是为您整理出来关于【Sphinx】合集内容，如果觉得还不错，请帮忙转发推荐。
有没有一种简单的方法来定制现有的sphinxdoc主题？对于默认主题,有许多主题属性,但在sphinxdoc中,我甚至无法设置徽标或更改某些颜色？ 或者你能推荐一个我可以学习如何修改主题的网站吗？解决方法:我只想在我的sphinx doc中添加ReST strikethrough.我是这样做的：$cd my-sphinx-dir $mkdir -p theme/static $touch theme/theme.conf $touch theme/static/style.css在theme / theme.conf中：[theme] inherit = default stylesheet =...
我对sphinx很新,我正在尝试将它用作我项目的API参考.也许在那之后作为项目文档. 我使用这两个命令生成它sphinx-apidoc -e -o doc/api tracer sphinx-build -b dirhtml doc/ build/doc/dirhtml它存在生成此目录的问题- tracer package- tracer.lang package- tracer.lang.en module- tracer.packageManagers package- tracer.packageManagers.dnf module- tracer.packageManagers.dpkg module- tracer.packageManagers.portage modu...
我在Python项目源代码中有一个字典,它描述了默认的配置值.字典很冗长.除了“查看源代码”之外,我还希望以其他格式查看Sphinx文档中的字典,以便人们可以快速检查默认值. 当与Sphinx autodoc一起使用时,Sphinx是否提供格式化字典变量的选项以用于人类可读的格式？我目前正在使用.. automodule ::来转储整个模块,我将字典作为文档中的一个长字符串转储(没有新行,漂亮的打印,任何东西),基本上是不可读的. > Sphinx是否提供了打印单个源...
我正在尝试在android中开发语音识别程序,到目前为止,我已经看到最流行的选项似乎是CMU sphinx,其中pocketsphinx用于android.据我所知,CMU Sphinx的源代码已经在Java中提供,可以在计算机上运行,??因此不会直接在Android手机上运行.所以我首先要将CMu sphinx代码编译成一种类型的库(如果我在C中工作,就像创建一个我需要共享的代码的dll),然后在android中构建一个接口并从cmusphinx调用类.所以我发现每个人都指的是this post和this tu...
如何判断自动扩展扩展不仅列出单个类,还列出所有类的成员？ 如果我使用：.. autosummary::MyClass在生成的html文件中,只有一个简短的摘要,如： MyClass(var1,var2,….)我的自定义类来做奇特的事情…… 我真正想要的是： MyClass(var1,var2,….)我的自定义类来做奇特的事情…… MyClass.doA(var1,var2,…)做得很好 MyClass.doB(var1,var2,…)B更好 我如何配置autosummary指令才能得到这个(除了在autosummary指令中自己命名所有函数)...
有没有一种方法,最好使用autodoc,使sphinx记录Python脚本？我要记录的脚本部分是受以下部分保护的部分：if __name__ == '__main__':即仅在模块用作脚本而不是导入时才运行的位.解决方法:您应该使用该文档字符串将该块中的代码提取到函数中,然后从该块中调用该函数.
我已经设置了狮身人面像文档,并且想要使用自定义主题.我已经阅读了狮身人面像网站上的主题说明：http://www.sphinx-doc.org/en/stable/theming.html,但是它不起作用. 我的主题名称与conf.py文件中的主题名称相同,并且位于同一目录的zip文件夹中,但是我不断收到以下错误消息：Theme error: no theme named 'tera' found (missing theme.conf?) make: *** [html] Error 2我的conf.py代码是：html_theme = "tera"html_theme_options =...
如果要允许人们使用“无”调用某些方法,则在定义方法时必须使用sentinel object._sentinel = object()def foo(param1=_sentinel):...这将使您能够调用foo(param1 = None)并能够在类似foo()的调用之间进行区分. 问题是,当Sphinx确实记录了该方法时,它将编写如下内容mymodule.foo(param1=<object object at 0x108c1a520>)如何说服Sphinx为这些功能提供用户友好的输出？ 注意,想象一下如果使用哨兵方法有3-4个参数,文档的外观.解决方法...
我有一些python模块,主要包含函数和一些类.每个文件都使用sphinx-autodoc在单独的rst中记录.我想做的是在每个页面的顶部创建表或模块内容的列表,例如,mymodule.py是def first():'First function'def second():'Second function'而mymodule.rst是Page Contents -------------:create_page_contents_list:Members -------.. automodule:: mymodule:members:然后,输出应如下所示：Page Contents -------------first secondMembers ---...
我在狮身人面像中收到此警告：WARNING: search index couldn’t be loaded, but not all documents willbe built: the index will be incomplete.但据我所知,它很好地构建了文档,包括搜索索引. 该错误消息实际上是什么意思,以及如何解决？ 从答案中注意到：当前调用是sphinx-build -W -n docs / docs / html * .rst.解决方法:错误消息是从这里： https://bitbucket.org/birkenfeld/sphinx/src/ef3092d458cc00c4b74dd342ea05ba1059a...