我想我遗漏了一些关于doctest的sphinx扩展。.. doctest::
1$ make doctest
其效果是测试代码片段，并将实际输出与预期输出进行比较。相反，我希望sphinx将实际输出单独插入到我的文档字符串或.rst文件中。例如
浏览 2提问于2012-03-22得票数 11
回答已采纳
如果这段代码在我的文档中是块引用，我需要做什么才能让在文档生成时运行它？today(): if True:一个.rst源代码和conf.py的Sphinxdoctest扩展，但我收到了一个错误，抱怨函数体的第一行出现意外缩进。Sphinx的doctest能够运行<em
浏览 0提问于2010-01-08得票数 4
回答已采纳
1回答
我正在尝试运行在我的第一个文档中编写的doctest。但是我不知道怎么运行它。我写了以下代码： .. doctest::
45 然后我就做了： $ make html 但是已经成功构建了文档。我也很感兴趣，如果一个人可以只运行测试，而不需要构建html文档？ 提前谢谢你。
浏览 11提问于2020-04-23得票数 0
我喜欢doctest，它是我使用的唯一的测试框架，因为它编写起来太快了，而且因为与sphinx一起使用，它几乎不费力气就能制作出如此出色的文档……""""""
我的意思是，我把我所有的测试和文档解释放在模块的顶部但是，我认为doct
浏览 0提问于2010-05-25得票数 2
回答已采纳
狮身人面像使用这个ReST生成html文档。sphinx-build -E -b html docs dist/docs如何检查生成的ReST标记？
浏览 0提问于2019-07-21得票数 1
回答已采纳
1回答
我想为一个基于Django的项目编写文档。我发现Django人为此使用了reStructureText和狮身人面像。我有以下问题。如何开始使用reStructureText和狮身人面像编写文档？
我应该遵循哪些最佳实践，以使文档保持良好的组织、版本化、易于理解和易于管理？
浏览 1提问于2011-08-10得票数 4
回答已采纳
1回答
我希望包含一个setuptools命令来运行Sphinx，作为包setup.py的一部分，如下所示：我有一个包结构，如：docs|---|---doctrees|---|---conf.py # Sphinxconfig
|---|---index.rst # Sphinx
浏览 3提问于2015-07-24得票数 3
回答已采纳
在Sphinx中doctest的意义是什么？有人能用一个简单的例子来帮助我理解它的用法吗？
浏览 4提问于2011-11-17得票数 1
回答已采纳
另一种问这个问题的方法是:如果我用reST编写文档测试，我可以将它用于Sphinx或其他自动文档编制工作吗？背景:我不知道如何使用Sphinx，也没有太多使用reST的经验，所以我想知道我是否可以在其他地方使用reST编写的文档测试而不是Sphinx？
浏览 0提问于2012-05-19得票数 0
回答已采纳
以下(无意义的) Python模块的doctest失败：>>> L = []...; doctest.testmod()
这是因为标记为XXX的行后的输出是<__main__.A object at ...> (由append_to返回)。当然，我可以将此输出直接放在标记为XXX的行后面，但在我的例子中，这会分散读者对实际测试内容的注意力，即函数append_to的副作用。那么，我如何抑制该输出，或者如何忽略它。A(objec
浏览 1提问于2010-10-05得票数 4
回答已采纳
1回答
我正在努力弄清楚如何让doctest与Sphinx一起工作，但它似乎并没有找到我的测试。下面是一个简单的例子。Returns the number 5. 5 return 5
当我运行make doctest我很确定我的配置是正确的，因为如果我运行make html，然后转到我的index.html文件，我就会看到文档<
浏览 2提问于2017-09-28得票数 1
回答已采纳
我正在用Sphinx生成我的python库的文档。我使用扩展 "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.viewcode&quo
浏览 1提问于2019-02-22得票数 0
回答已采纳
我通常在每个Sphinx文档项目中使用某些扩展，比如sphinxcontrib.bibtex，这意味着我需要为每个项目将扩展名添加到conf.py文件中。They can be extensionsextensions =['sphinx.ext.autodoc', 'sphinx.ext.
浏览 5提问于2013-09-20得票数 1
回答已采纳
1回答
自动生成的文档复制了Test类的Methods，如下所示。为什么会发生这种重复，如何才能阻止它？ 我在conf.py模块中尝试了几个变体，但都没有用。在文档图像之后，是此模块的编辑版本。extensions = ['sphinx.ext.autodoc', 'numpydoc','sph
浏览 17提问于2020-08-07得票数 1
回答已采纳
我似乎无法让斯芬克斯自动文档和doctest扩展很好地结合在一起。
我有一个经过文档测试的Python项目，其中的docstring工作得很好。也就是说，在我的模块和子模块上调用doctest.testmod()很好。在项目的狮身人面像文档中，我使用ext.autodoc扩展和automodule指令自动将模块的文档导入每个模块的.rst文档中。但是，问题是，很明显，doctest
浏览 3提问于2014-12-01得票数 1
当使用狮身人面像的make doctest时，在测试中创建的Django模型被提交到数据库；我们如何防止它们自动提交或在每个测试之间重置数据库(使用与pytest类似的方法)？(在sphinx-quickstart__中创建独立的源目录和构建目录。)：python manage.py migrate
当我运行pytest时，文档中的测试每次都会运行</e
浏览 3提问于2021-01-27得票数 0
/build/temp.linux-x86_64-2.7'))，那么Sphinx可以找到所有模块并生成文档，但在这种情况下，我会得到类似error while formatting arguments这可能是因为现在Sphinx只能访问*.so文件，而不能访问源文件。同样的sys.path修改也允许通过Sphinx (make doctest)运行文档测试。在这种情况下，文档构建正确，但我认为doctest</em
浏览 3提问于2012-04-08得票数 23
回答已采纳
我正在使用Sphinx autodoc来记录我的Python代码。我的文件中的例子包括：
Then you process file `example.txt` with_ = f.write("second boring line\\n")
浏览 2提问于2015-08-13得票数 1
回答已采纳
我正在使用带有numpydocs、doctest和scipy主题的sphinx。 在文档字符串中使用.. plot::时，将创建所有绘图，除非它们都移动到文档的末尾，而不是显示调用它们的位置。有没有一种方法可以强制它内联，而不需要在.rst文件中重写示例？这是我的example.py文件文档字符串的样子： .. plot::
>>> import matplotlib.p
浏览 30提问于2020-03-26得票数 1
回答已采纳
我在试图从doctest上运行时遇到了问题。下面有目录树，但不能运行doctest用于lumache.py。如何才能使lumache.py能够与conf.py中的pathlib函数(也就是我正在尝试执行的sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix()).The代码)中的pathlib函数相关联，这与教程(第一句中提到的超链接)是相同的。sys
sys.path.inser
浏览 14提问于2022-06-30得票数 3
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
云直播活动推荐
腾讯云开发者
