Python Makefile Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
source
tools
.gitignore
LICENSE
Makefile
Makefile.vars.sample
README.rst
gh-pages.sh

README.rst

読書ノート

概要

このリポジトリーは 読書ノート の原稿群だ。 Python 製パッケージ Sphinx でビルドするための rst ファイル群で構成している。

読者(私)向け説明

これは事故か何かが私の身に起こって、 ゼロから環境を作らなければならなくなった事態を想定して書いている。

ノート作業だけならば rst ファイルをテキストエディターで編集し続けていけばよい。 これを HTML ファイル群に仕立てて上記 URL に配備するには、少々の手間を要する。 以下、環境のセットアップ手順と、アップロードする手順の両方を説明する。

セットアップ

次の三つに分けて説明する。

  1. ツール準備
  2. ローカルコピー作成
  3. 初回ビルド

最初にツールを説明する。 標準的な Windows 環境で必要なツール群をザッと挙げるとこういう感じだろうか。

Cygwin あるいはそれ相当

とにかくコンソールだ。これらのツールを多用する。

  • bash
  • make
Python
最新バージョンで稼動するようにしている。今なら 3.5.0 に相当する。
Sphinx
Python が使えるようになったら pip install sphinx にて依存パッケージを込みで自動的にインストールできる。 現在利用中の Sphinx のバージョンは 1.3.1 だ。
Git
Cygwin 版でも Windows 版でも構わないハズだが、現在は後者を用いている。

次にローカルコピーの作成手順を説明する。 一言で言えばコマンドラインから git を用いて GitHub のサーバーからファイルをダウンロードする。 仮にゼロからビルド環境を構築するとなると、次のことをすれば最新の状態を再現できる。

$ cd $MY_DEV_DIR
$ git clone https://github.com/showa-yojyo/notebook.git
$ cd notebook
$ git checkout develop

最後にビルド手順を説明する。 ノートのビルドは notebook ディレクトリー直下で次のようにする。 初回のみ git clone が必要であることに注意して欲しい。

$ git clone -b gh-pages --single-branch https://github.com/showa-yojyo/notebook.git gh-pages
$ make gh-pages

アップロード

ビルドしたファイル群を GitHub のサーバーにアップロードする方法を記す。 アップロードには次のふたつの目的がある。それぞれ手順が異なる。

  1. ノート本体のリポジトリーの更新
  2. ビルド成果物の更新

前者は notebook ディレクトリー直下で、 後者は gh-pages ディレクトリー直下でそれぞれ git push する。

  • HTML ファイル群の push は普通に行う。
  • 日常ルールではソースコードの push は develop ブランチのみに限定している。
  • プッシュすると Twitter の私のタイムラインにコミット数分だけのログが自動的に流れる。 あまり人の目につかない時間帯に push したい。

非読者(一般の皆さん)向け説明

当リポジトリー内の全リソースは私個人が私個人のために記したものなので、 誤字脱字、事実・真実に反する記述、等々の報告をいただけると私が個人的に助かる。 しかしながら訂正作業のリクエストには応じられるとは限らないので、了承願いたい。 申し訳ない。

Licensing

同梱の LICENSE ファイルを参照して欲しい。

開発陣

当リポジトリーの管理人とその連絡手段の一覧を以下に記す。

プレハブ小屋

当読者ノート主筆。