django - python スフィンクスのドキュメント

Question

このプロジェクトを文書化の目的でどのように使用できるか教えて ください http://sphinx.pocoo.org

CentOS マシンに正常にインストールしました。インストール後、Readme ファイルには sphinx-quickstart を実行するように記載されており、ドキュメントのルートは /home/tom/Docs です。

ここからどこへ /home/tom/Docs のコマンドをどのように使用できますか ファイルがあります __build conf.py index.rst make.bat Makefile _static _templates

次は? /usr/my-site にある私の django プロジェクトのレポートを生成する方法

Answer 1

まあ、あなたは自分でいくつかの読書をしなければならないでしょう。ただし、基本的な概要として:

• 通常、ドキュメント用にプロジェクトのサブフォルダーで sphinx-quickstart を実行します (例: /usr/my-site/docs)。
• Sphinx ドキュメントはreStructuredText (rst) 形式で記述します。index.rst ファイルを編集することから始めます。後でさらにファイルを追加できます。
• 完了したら、make html（または Windows では make.bat html を使用して）RST から HTML ファイルを作成します。