ドキュメント編集メモ¶
このドキュメントは Sphyinx を使って作成しています。 ReST 記法が利用できるので、お手軽、かつ多様な表現が可能です。
格納場所¶
ドキュメントのソースは、linuxjm プロジェクトの git repository の guide ディレクトリに
あります。以下のコマンドでダウンロードしてください。
git clone https://scm.osdn.net/gitroot/linuxjm/jm.git
このコマンドを実行すると、たとえば以下のようにダウンロードに関する情報が表示され、カレントディレクトリに jm というディレクトリが作成され、その中にドキュメントのソースを含むファイルがダウンロードされます。
Cloning into 'jm'...
remote: Counting objects: 55547, done.
remote: Compressing objects: 100% (10601/10601), done.
remote: Total 55547 (delta 40455), reused 55442 (delta 40410)
Receiving objects: 100% (55547/55547), 45.31 MiB | 2.38 MiB/s, done.
Resolving deltas: 100% (40455/40455), done.
Updating files: 100% (10822/10822), done.
この後の作業は jm のディレクトリ配下で行いますので、
cd jm
としておいてください。以下の説明ではすべてカレントディレクトリ が jm であることを仮定しています。
ドキュメントの build 方法¶
build 環境の準備¶
自分の環境でドキュメントの build を確認するには sphinx をインストールする 必要があります。
python の pip コマンドを使う場合は
$ pip install -r requirements.txt
としてください。上記のコマンドを使用した場合は、
sphinx がインストールされます。
あるいは、 各ディストリビューションの手順に従ってインストールしてください。たとえば openSUSE の場合は、zypper コマンドで python3-sphinx と python3-sphinx-bootstrap-theme をインストールしてください。Debian/Ubuntu の場合は、python3-sphinx がパッケージ名です。
build 方法¶
カレントディレクトリ (jm になっているはずです)から、まず、ドキュメントが含まれるサブディレクトリまで移動します。次に、 make を実行し、表示用のファイルを作成します。
$ cd guide
$ make html
出来上がった html ファイルは _build/html に格納されます。
作成されたドキュメントを破棄して作り直すには以下のようにします。
$ make clean
$ make html