Sphinxの基本的な使い方

インストール

  • aptでもpipでも可能.

    $ sudo apt install python-sphinx
    

起動(クイックスタート)

  • 初期設定をディプロイするコマンド "sphinx-quickstart" がある.

    $ sphinx-quickstart
    
    • 実行後は基本的に "y"連打 で問題ない.( あとからカスタマイズ可能 )

    • "build" と "source" は分けたほうが良い(特にHTML)


コンパイル

  • ベースディレクトリ(quickstartしたディレクトリ)にて、make コマンドで生成対象を指定して文書作成.

    ( e.g 1 )  $ make html
    ( e.g 2 )  $ make latexpdf