首页 > TAG信息列表 > python-sphinx

我如何让Sphinx测试文档中嵌入的代码？

如果此代码在我的文档中是blockquote,那么在生成文档时,我该怎么做才能使Sphinx运行它？我尝试添加 .. testcode:: import datetime def today(): return datetime.datetime.now().date() if True: today() 到.rst来源之一和conf.py的Sphinx doctest

django sphinx automodule —基础知识

我有一个包含多个大型应用程序的项目,其中的设置和应用程序文件被拆分. 目录结构是这样的： 项目名 > __init__.py >应用 > __init__.py> app1> app2 >第三党 > __init__.py> lib1> lib2 >设置 > __init__.py> installed_apps.py> path.py> templates.py> locale.py> … > url

python-sphinx：格式化多行文档字符串

使用sphinx autodoc,是否可以通过特殊方式格式化多行文档字符串的第一行？ 考虑： def whatever(): """This function does something. This really should have a full function definition, but I am too lazy. Some more stuff. """ 生成的html代码： <dd

python-Sphinx使用旧的模块代码

我使用Sphinx记录我的代码,该代码是Python模块的集合.通过清理我的源代码制作的自动生成的文档很好,但是当我单击直接链接到包含Sphinx生成的包含包源代码的HTML页面的“代码”链接时,将显示我的代码的较旧版本. 我试图删除我的Sphinx生成的文档,从自己的site-packages文件夹中卸载

python-使用Sphinx记录烧瓶应用程序

我将Flask与应用程序工厂模式一起使用,因此我的整个应用程序都包含在一个函数中. 这就产生了一个问题,因为Sphinx在工厂中“隐藏”在我的视图和方法中,所以我没有在其中记录我的视图和方法. 想解决这个问题？ (除了“将所有视图放入蓝图中”的想法,尽管这是一种很好的模块化方法)解决

python-检查Sphinx文档是否调用了脚本

我目前正在尝试为使用ArcGIS arcpy库的脚本生成sphinx文档. 当sphinx在生成文档时尝试运行脚本时,我遇到了一个问题,因为arcpy脚本从arcgis gui中获取输入参数.由于sphinx在不使用gui的情况下调用脚本,因此这些参数为空,并导致回溯,例如： C:\VersionControl\PythonScripts\Source\s

python-将setUp和tearDown unittest方法保留在Sphinx文档之外

我正在使用docstrings和autodoc使用Sphinx为我的项目构建文档.我喜欢在文档中包含测试类和实际测试用例的描述,但是我想省略setUp和tearDown.我尝试在.rst文件中指定它,但是我没有用(不是我真的期望它,我敢肯定,undoc成员仅适用于顶级构造-全局函数和类) API.tests.test_MSSQLTool

python-在狮身人面像文档中打印变量值

假设我有一个模块名称module.py,并且在其中有一个名为_VAR的私有变量,我想在我的狮身人面像文档中打印它的值. module.py _VAR = 20 在狮身人面像中,我想要这样的东西： index.rst The value of ``module._VAR`` is :py:print:`module._VAR` 输出将是： The value of module._VA

python-sphinx：通过raw :: latex包含.tex文件

我想在狮身人面像中包含乳胶文档. sphinx html构建不包括使用.. raw :: latex指令链接的乳胶文件.我有 这是我的目录结构 docs/ source/ importlatex.rst index.rst build/ tex/ texfile.tex index.rst看起来像 Welcome to documentation!

python-Sphinx搜索索引警告

我在狮身人面像中收到此警告： WARNING: search index couldn’t be loaded, but not all documents will be built: the index will be incomplete. 但据我所知,它很好地构建了文档,包括搜索索引. 该错误消息实际上是什么意思,以及如何解决？ 从答案中注意到：当前调用是sphinx-bu

python-spinx命令缺少conf文件

我在运行tox命令来为我的Python项目生成Shpinx文档时遇到问题.这是错误. docs runtests: PYTHONHASHSEED='1181019260' docs runtests: commands[0] | sphinx-build -W -b html -c ./conf.py -d /Users/rakesh.kumar/ll/client-location/limekiln/.tox/docs/tmp/doctrees . /Users

python-在列表项中结束文字块

我的第一个文件中有一个列表项,我想将一个文字块放入其中,但无法使文字块正常结束. 这是我的第一个： 1. Item 1 (not literal) 2. Item 2:: MyCode.example() Description of the code shown above (not literal) 我希望以Description开头的段落在其上方的文字块之外,但

python-如何在列表元素中添加锚点

我的第一个文件中有一个列表,如下所示： - Item 1 - Item 2 - Item 3 它呈现如下内容(这正是我想要的)： >项目1 >项目2>项目3 我想为每个项目创建链接,所以我做了 .. _item-1: - Item 1 .. _item-1: - Item 2 .. _item-1: - Item 3 现在,我的列表呈现如下内容： >项目1 >项目2

使用Sphinx记录python脚本条目(__name__ ==’__main__’)

有没有一种方法,最好使用autodoc,使sphinx记录Python脚本？我要记录的脚本部分是受以下部分保护的部分： if __name__ == '__main__': 即仅在模块用作脚本而不是导入时才运行的位.解决方法:您应该使用该文档字符串将该块中的代码提取到函数中,然后从该块中调用该函数.

python-Sphinx-自定义主题不起作用

我已经设置了狮身人面像文档,并且想要使用自定义主题.我已经阅读了狮身人面像网站上的主题说明：http://www.sphinx-doc.org/en/stable/theming.html,但是它不起作用. 我的主题名称与conf.py文件中的主题名称相同,并且位于同一目录的zip文件夹中,但是我不断收到以下错误消息： Theme e

使用带有哨兵对象默认参数的Sphinx python方法进行文档记录？

如果要允许人们使用“无”调用某些方法,则在定义方法时必须使用sentinel object. _sentinel = object() def foo(param1=_sentinel): ... 这将使您能够调用foo(param1 = None)并能够在类似foo()的调用之间进行区分. 问题是,当Sphinx确实记录了该方法时,它将编写如下内容

python-Sphinx：模块中的功能列表

我有一些python模块,主要包含函数和一些类.每个文件都使用sphinx-autodoc在单独的rst中记录.我想做的是在每个页面的顶部创建表或模块内容的列表,例如,mymodule.py是 def first(): 'First function' def second(): 'Second function' 而mymodule.rst是 Page Contents -

python-如何在readthedocs上记录cython函数

在ReadTheDocs上,我不允许编译cython扩展名,是否可以配置sphinx以便从cython文件中提取文档字符串而无需实际编译它们？ 谢谢！解决方法:我遇到了同样的问题,发现现在可以在readthedocs上编译Cython扩展了. 简短答案：Cython模块可以使用readthedocs提供的virtualenv功能进行编译. 有关稍

我如何使用Sphinx在特定部分记录成员？

我正在努力弄清楚如何将我的Python类的特定成员的文档放在Sphinx文档的特定章节中,理想情况下是如何在另一部分中自动记录其余内容. 我有一个Python课 class MyClass(object): def funky(self, arg): """Some docs.""" ... 在my / module.py中定义,它可以按

Python Sphinx Autosummary：成员函数的自动列表

如何判断自动扩展扩展不仅列出单个类,还列出所有类的成员？ 如果我使用： .. autosummary:: MyClass 在生成的html文件中,只有一个简短的摘要,如： MyClass(var1,var2,….)我的自定义类来做奇特的事情…… 我真正想要的是： MyClass(var1,var2,….)我的自定义类来做奇特的事情…… M

如何在Sphinx处理的文档字符串中为单个参数或返回值表达多个类型？

有时Python中的函数可能接受灵活类型的参数.或者它可以返回灵活类型的值.现在我不记得现在这样一个功能的一个很好的例子,因此我在下面用玩具示例展示这样的功能可能是什么样子. 我想知道如何使用Sphinx文档表示法为这些函数编写文档字符串.在下面的示例中,参数可以是str或int.同样

python – Sphinx apidoc – 不打印包和模块的完整路径

我对sphinx很新,我正在尝试将它用作我项目的API参考.也许在那之后作为项目文档. 我使用这两个命令生成它 sphinx-apidoc -e -o doc/api tracer sphinx-build -b dirhtml doc/ build/doc/dirhtml 它存在生成此目录的问题 - tracer package - tracer.lang package - t

python – 在Sphinx文档中显示字典数据

我在Python项目源代码中有一个字典,它描述了默认的配置值.字典很冗长.除了“查看源代码”之外,我还希望以其他格式查看Sphinx文档中的字典,以便人们可以快速检查默认值. 当与Sphinx autodoc一起使用时,Sphinx是否提供格式化字典变量的选项以用于人类可读的格式？我目前正在使用.. aut

如何用doxygen记录Python代码

我喜欢doxygen来创建C或PHP代码的文档.我有一个即将推出的Python项目,我想我记得Python没有/ * .. * / comments,并且还有自己的自我文档工具,这似乎是pythonic的文档方式. 由于我熟悉doxygen,我如何使用它来生成我的Python文档？有什么特别需要注意的吗？解决方法:这是documented on t

python – 自定义sphinxdoc主题

有没有一种简单的方法来定制现有的sphinxdoc主题？对于默认主题,有许多主题属性,但在sphinxdoc中,我甚至无法设置徽标或更改某些颜色？ 或者你能推荐一个我可以学习如何修改主题的网站吗？解决方法:我只想在我的sphinx doc中添加ReST strikethrough.我是这样做的： $cd my-sphinx-dir $mkd