pdoc 0.1 documentation

Sphinx

«  StartSSL   ::   Contents   ::   宅内環境  »

Sphinx

ドキュメント書く用のSphinxについて

Windowsでの導入

Python2.7を入れる

ダウンロードして、普通にインストール

easy_installを入れる

ダウンロードしてダブルクリック

pipを入れる

C:\Python27\Scripts\easy_install pip

virtualenvを入れる

C:\Python27\Scripts\pip install virtualenv

編集場所を作る

編集ディレクトリを “C:devsphinx” にする。

cd C:\dev
C:\Python27\Scripts\virtualenv --distribute sphinx

activate起動用バッチファイルを作って楽する。

cmd /k C:\dev\sphinx\Scripts\activate

Note

以降は virtualenv 空間で作業するので、環境変数のPATHを設定しなくても動く。

Sphinxとその拡張を入れる

pip install sphinx

プロジェクトの作成

sphinx-quickstart

違うテーマを使うとき

pip install sphinxjp.themecore
pip install sphinxjp.themes.dotted

テーマの設定

html_theme = 'dotted'

個人的によく使うテーマ設定

html_theme_options = {'slidetoc': False,
                      'enablesidebar': True,
                      'rightsidebar': False,}

diagシリーズを使うとき

easy_install Pillow
pip install sphinxcontrib-blockdiag
pip install sphinxcontrib-nwdiag

Note

Pillow と rst2pdf は pip から入れようとすると “error: Unable to find vcvarsall.bat” とか言うので easy_install で入れてお茶を濁すことにする。どちらにしてもvirtualenv環境だし、まぁいいだろう。そして、思えば Blockdiag とか使うタイミングあんまりない。

«  StartSSL   ::   Contents   ::   宅内環境  »