关于为django应用程序编写文档入门

我想为我的一个基于django的项目编写文档。我发现django人为此使用了reStructureText和Spinx。我有以下疑问。关于为django应用程序编写文档入门

感谢和问候狮身人面像的

关于组织，请看看任何一个维护良好的Django项目（南，django-compressor，django-haystack等），并浏览readthedocs.org，您将很快得到感觉如何组织事情。也就是说，只要它具有某种意义，它就是个人喜好。 –

感谢Gabriel的宝贵意见。 –

你开始运行sphinx-quickstart。
“有条不紊”是你自己的事情。这取决于你的品味和你的项目。
“易于管理”：在您的代码文档中包含doctests，在您的sphinx设置中包含autodoc。通过这种方式，您可以随时查看运行测试服务时您的文档是否与您的代码相匹配。（但只使用doctest来测试你的文档，测试你的代码，你应该有单独的单元测试，否则文档将无法使用......）
至于“容易理解”，这真的取决于你。

2011-08-10 06:12:40 xubuntix

我不是doctests + autodoc的忠实粉丝，因为它可能导致代码文件中非常长的非代码块，但除此之外，这是一个很好的答案。 –

回答