有关为Django应用程序编写文档的入门[关闭]

Question

关闭。这个问题需要更多focused。它当前不接受答案。

---

是否要改善此问题？更新问题，使其仅按editing this post专注于一个问题。

关闭2年前。

我想为我的一个基于django的项目编写一个文档。我发现django人为此使用了reStructureText和Spinx。我有以下查询。

• 如何开始使用reStructureText和Sphinx编写文档？
• 我应该遵循哪些最佳实践，以使文档保持井井有条，版本易于理解和管理？

感谢和问候

Answer 1

狮身人面像的文档在这里：https://www.sphinx-doc.org

• 您先运行sphinx-quickstart。
• “井井有条”实际上是您自己的事。这取决于您的品味和项目。
• “易于管理”：在代码文档中包含doctests，在狮身人面像设置中包含autodoc。这样，您在运行测试套件时始终可以查看文档是否与代码匹配。 （但只能使用doctest来测试您的文档，要测试您的代码，应该有单独的单元测试，否则该文档将无法使用...）
• 至于“易于理解”，这完全取决于您。