sphinxの導入方法

このページにはsphinxの導入方法についてメモしておきます. とは言いつつも正直公式サイトの情報で十分な気もします.

まぁ,あくまで,私のメモ書き程度で.

pipを使用したインストール

pythonの開発環境が整っているマシンの場合,sphinxの導入をpipコマンドから 実行することができます. なんと言うか,例えばsudo権限を持っていないPCにsphinxを導入したい場合などは, 自分権限で利用可能なpythonをビルドして,そこからpipコマンドを利用すればよいので そういう意味では柔軟な導入方法になるかと(このページのあるサーバーにもこの方法でsphinxを導入しています).

bash:

$ sudo pip sphinx

• 自分でpython環境をビルドしていない場合は上記のコマンドで導入できるかと(Mac,Linuxマシンであればpythonは導入されているはずですから)
• pipの導入に関してはこのページでは省略します.

python環境とかよくわかんない場合

私の場合,メイン機,サーバー機すべてがLinuxなので,apt-get系のコマンドを利用してインストールを行うのが 一番単純です.Macを使用している場合,MacPortかなんかで行けるのではないでしょうか. ただし,このやり方の場合,どうしてもsudo権限が必要になります(当たり前ですが...).

bash:

$ aptitude install python-sphinx

• 各,OSによってアプリケーションのインストールコマンドは異なります.

  • 基本的にubuntu,Debian系は上記のコマンド
  • centOS, Fedora は yum
  • OpenSUSE は zypper
  • Macは少し前だったらMacPortですか??

とりあえず使用してみる

sphinxで文章を作成する場合,任意のディレクトリに移動して以下のコマンドを入力します.

bash:

$ sphinx-quickstart

色々と聞いてきますが入力が必須になるのは以下の質問に対してのみで,後は何も考えずEnterを押せばよいです(大半が拡張機能を導入するかという質問です.数式を導入したい,TODOリストを作成したい等,需要に合わせて変更が必要な場合もあります).

• 解答が必要な質問リスト

  • > Project name: プロジェクト名:ウェブサイトのページ名だと思ってください
  • > Author name(s): 製作者名:基本的には自分の名前(任意で大丈夫です)
  • > Project version: プロジェクトバージョン:一般に制作日時を入れるようです

• よく使う拡張

  • > todo: write “todo” entries that can be shown or hidden on build (y/N) [n]:

    Todoリストを導入したい場合”y”と入力します
  • > jsmath: include math, rendered in the browser by JSMath (y/N) [n]:

    数式を記述したい場合”y”と入力します

• 拡張機能等は後からでも編集可能です.

  • 編集を行う場合,conf.pyファイルを編集します.

上記,入力が終了すると,sphinxプロジェクトが完成します.