karad / cakespa_sphinx

これは何？

cakespa.org で公開されているドキュメントです。 これらのドキュメントは全て、 Sphinx を使って管理されています。

貢献する

以下の手順でこのドキュメントに貢献できます。

1. このリポジトリをフォークする。
2. 下記に定めるルールに従って、ドキュメントを記載する。
3. プルリクエストを送る。
4. このリポジトリの管理者が修正し、変更を取り入れる。
5. cakespa.org に反映される。

ドキュメントに関するルール

ドキュメントを書く際は下記のルールに従ってください。

• page.rst.exampleを参考にドキュメントを作成する。
• ドキュメントはdocumentsディレクトリ以下に配置する。
• 1ページで終わる記事は、ディレクトリを作成しない。
• 複数ページに渡る記事は、documentsディレクトリのルートにトップページを作成する。その他のページはトップページと同名のディレクトリを作成し、その中に配置する。
• 画像は_staticディレクトリに配置する。内部のディレクトリは、ドキュメントと同じ構成で配置する。

ドキュメントで使用するマークアップ

reStructuredTextを使用します。 下記のページを参考に、ドキュメントを書いてください。

• reStructuredText入門

自分でビルドする

自分でビルドするためには、Sphinxのインストールが必要です。 以下の記事を参考に、Sphinxをインストールしてください。

• Pythonって何？という人のためのSphinxインストール入門

UbuntuやDebianをお使いの方は、apt-get installでなく、easy_installを使った方法をお勧めします。
UbuntuやDebianで管理されているSphinxのパッケージは、バージョンが古いためです。

インストール後は下記のコマンドで、ビルド出来ます。

make html

CentOS/FedoraにSphinxをインストールする

1. yum install python-setuptools
2. easy_install -U Sphinx

UbuntuにSphinxをインストールする

1. apt-get install -y python-setuptools
2. easy_install -U Sphinx

WindowsにSphinxをインストールする

• Windowsへのインストール

MacOSにSphinxをインストールする

1. Xcodeをインストールする ( Download Xcode )
2. curl -O http://peak.telecommunity.com/dist/ez_setup.py
3. sudo python ez_setup.py
4. sudo easy_install sphinx