プロジェクト

全般

プロフィール

Sphinx

Sphinxとは

以前、はてな日記に書いた内容を参照
http://d.hatena.ne.jp/torutk/20110519/p1

Windows へのSphinxインストール

Sphinxは、Pythonのモジュールとして作成されているので、素のWindowsにSphinxをセットアップするには、Python、依存モジュール、Sphinxを入れていく必要があります。
それなりに手間なので、必要なものをひとまとめにしたスタンドアロンインストーラがSphinx-Users.jpで用意されています。
http://sphinx-users.jp/gettingstarted/install_windows_standalone.html

スタンドアロンインストール

ダウンロードしたスタンドアロンインストーラファイルを、管理者として実行します(エクスプローラ上でファイルを右クリックして[管理者として実行]をクリック)。

  • SphinxInstaller-1.2.3.20141115-py2.7-win32.exe

インストール後、コマンドプロンプトを起動し、次のコマンドが実行できるか確認します。

C:\Users\torutk> sphinx-py

>>> ^Z

C:\Users\torutk>

個別インストール

Pythonのインストール

Sphinxは、Phyton 2.7系、3.x系に対応していますが、利用実績の多い2.7をインストールします。
Pythonのダウンロードページから、2.7系の最新版のDownloadをクリックします。
https://www.python.org/downloads/

Windows用のMSI形式が32bit版、64bit版と用意されていいるので、OSの版に合わせてインストールします(64bit版OSで32bit版のPythonをインストールすることも可能ですが)。

  • インストール先は空白を含まないディレクトリにします(デフォルトは C:\Python27)。
  • インストーラのコンポーネント選択で、PATHの設定を有効にしておきます。
  • 2.7.10をインストールしたら、pipも含まれていました。

Sphinxのインストール(pip)

コマンドプロンプトを管理者権限で開きます。

C:\> pip install sphinx
  :

動作確認

D:\>sphinx-build -h
Sphinx v1.3.1
Usage: sphinx-build [options] sourcedir outdir [filenames...]
  :

rst2pdfのインストール(pip)

Sphinx文書をPDFに生成する方法の1つに、rst2pdfがあります。

C:\> pip install rst2pdf
  :

LinuxへのSphinxインストール

openSUSE on Windows Subsystem for Linux

OS標準パッケージにshpinxの有無を確認しました。

~$ zypper search sphinx                                                                                 
Loading repository data...                                                                              
Reading installed packages...                                                                           

S | Name                                | Summary                                              | Type   
--+-------------------------------------+------------------------------------------------------+--------
  | python-Sphinx                       | Python documentation generator                       | package
  | python-Sphinx-doc                   | Documentation for python-Sphinx                      | package
  | python-Sphinx-latex                 | Sphinx packages for LaTeX                            | package
  | python-oslosphinx                   | OpenStack Sphinx                                     | package
  | python-pylons_sphinx_theme          | Pylons themes for python-Sphinx generated document-> | package
  | python-repoze.sphinx.autointerface  | Sphinx extension: auto-generates API docs from Zop-> | package
  | python-sphinx-testing               | testing utility classes and functions for Sphinx e-> | package
  | python-sphinx_rtd_theme             | ReadTheDocs.org theme for Sphinx                     | package
  | python-sphinxcontrib-breathe        | Sphinx "breathe" extension                           | package
  | python-sphinxcontrib-docbookrestapi | Extension to Sphinx for generating REST API docume-> | package
  | python-sphinxcontrib-httpdomain     | Sphinx domain for HTTP APIs                          | package
  | python-sphinxcontrib-issuetracker   | Sphinx integration with different issuetrackers      | package
  | python-sphinxcontrib-pecanwsme      | Extension to Sphinx for documenting APIs built wit-> | package
  | python-sphinxcontrib-programoutput  | Sphinx extension to include program output           | package
  | python3-Sphinx                      | Python documentation generator                       | package
  | python3-Sphinx-doc                  | Documentation for python3-Sphinx                     | package
  | python3-repoze.sphinx.autointerface | Sphinx extension: auto-generates API docs from Zop-> | package
  | python3-sphinx_rtd_theme            | ReadTheDocs.org theme for Sphinx, 2013 version       | package
  | python3-sphinxcontrib-issuetracker  | Sphinx integration with different issuetrackers      | package
$ sudo zypper install python-Sphinx
  :
work$ sphinx-quickstart
  :

クリップボードから画像を追加 (サイズの上限: 1 GB)