Python 我为什么要用重组后的文本写博士论文？

另一种提问方式： 如果我在reST中编写doctests，我可以将其用于Sphinx或其他自动文档工作吗

背景：我不知道如何使用Sphinx，对reST也没有太多经验，所以我想知道我是否可以在其他地方使用reST编写的Doctest，而不是Sphinx

我为什么要用重组后的文本写博士论文

您并不是真的“在重组文本中”编写测试。交互示例是测试用例，周围的标记看起来是什么并不重要；可以是休息，也可以是降价或乳胶

reST已经被采纳为Python文档的标准，但是您没有义务使用它

---

那么，为什么doctest文档中doctest.testfile（）的简单用法示例会作为reST文件给出呢

Doctest是一种通过检查文档中嵌入的交互示例的正确性来测试代码的方法，因此也包括reST标记是有意义的

可以对只包含交互式输入/输出示例而不包含其他内容的文本文件运行doctest。这些示例可以作为轻量级单元测试使用，但它们本身不太适合作为文档

我想知道我是否可以在其他地方使用reST编写的doctests，而不是Sphinx

即使您不在文档中使用Sphinx，拥有可测试的代码示例也是很有用的

如果您正在寻找理解reST的替代文档工具，请查看docutils（Sphinx基于它，顺便说一句）及其，例如rst2html.py

---

另一个可能感兴趣的工具是。

向文档中添加doctest有助于确保文档中的代码实际按预期工作。所以，您正在测试您的文档。对于一般的代码测试，根本不推荐使用doctest。

没什么，我不知道如何使用Sphinx，只是读过它，对reST也没有太多经验。坦白地说，我有点害怕Sphinx及其所需的开销，所以我只是想知道，如果我不使用Sphinx，在reST中编写doctests是否有任何好处？有什么更简单的方法可以利用我在reST中编写doctest这一事实吗？我不明白你的问题：你的意思是在用rst编写的单独文档中包含doctest吗？或者将rst添加到文档字符串中？对于doctest，您实际上不需要rst，但是对于文档，您需要rst。那么，为什么doctest文档中doctest.testfile（）的简单用法示例会作为reST文件给出呢，第25.2节。2@K.-MichaelAye它经常一起使用，您可以使用doctest测试文档中给出的示例。另请参见mzjn的回答。很抱歉延迟接受。当时一定太忙了。