はじめにdjangoアプリケーションのドキュメントを書く方法

Question

私のdjangoベースのプロジェクトのドキュメントを書いてみたいと思います。私はdjangoの人々がこの目的のためにreStructureTextとSpinxを使用することを発見しました。私は次の質問をしています。

• reStructureTextとSphinxを使用してドキュメントを書き始めるにはどうすればよいですか？
• ドキュメントが整理されたままで、バージョンが分かりやすく分かりやすく管理しやすいようにするためのベストプラクティス

おかげで、よろしくスフィンクスの

Answer 1

ドキュメントはこちらです：http://sphinx.pocoo.org/

• あなたがsphinx-quickstartを実行することから始めます。
• 「よく整理されました」というのはあなた自身の問題です。これはあなたの好みとプロジェクトによって異なります。
• "管理が簡単"：コードドキュメントにdoctests、スフィンクスセットアップでautodocを含める。このようにして、テストスイートを実行するときにドキュメントがコードと一致するかどうかを常に確認できます。 （しかし、あなたのコードをテストするためにdoctestを使う、あなたのコードをテストする、あなたは別の単体テストが必要です。そうでなければ、ドキュメンテーションは使えなくなります...）
• "分かりやすい"というのはあなた次第です。