- dockerインストール
- vscodeインストール
- remote-containerプラグインインストール
- dockerを起動してremote-containerに入る
pythonは3.7系がsphinx-autobuildが利用できるためおすすめです。
すでに入っている方は、飛ばしてください。
choco install -y python --version=3.7.5
$ brew install pyenv
/.bash_profileまたは、/.zshrcに以下を追加
export PYENV_ROOT=${HOME}/.pyenv
if [ -d "${PYENV_ROOT}" ]; then
export PATH=${PYENV_ROOT}/bin:$PATH
eval "$(pyenv init -)"
fi
pythonをバージョン指定してインストールし
$ pyenv install 3.7.7
$ pyenv global 3.7.7
choco install plantuml
$ brew install plantuml
$ python -m venv .venv
# venv環境を有効化
. .venv/bin/activate
# もしくは
source .venv/bin/activate
# venvライブラリインストール
(.venv) $ pip install -r ./requirements.txt
# venv環境を無効化する場合
deactivate
ライブラリの一覧をファイルに出力し、インストールするライブラリ一覧を更新する
pip freeze > requirements.txt
autobuildを起動するとブラウザで確認しながら執筆できます。
(.venv) $ sphinx-autobuild ./source ./docs
# もしくは
(.venv) $ make livehtml
autobuildで反映されない部分が実行すると、反映されるかもしれません。
(.venv) $ make buildhtml
PDF生成は、dockerコマンドで実行します。 リモートコンテナを使っている場合は、リモートコンテナ外で実行してください。
docker build --pull --rm -f "Dockerfile" -t blackpoker-doc:latest "."
docker run --rm -it -v `pwd`/docs:/docs blackpoker-doc:latest
文章の確認でredpenを使うことができます。 実行方法は、以下を参照してください。
[[../redpen/redpen.md]]
BlackPoker
├── Dockerfile :公式ルール用HTML,PDF生成Dockerfile
├── Makefile :sphinxのビルド設定
├── README.md :GitHubでトップに表示されるMD
├── base-docker :blackpoker-doc-baseのイメージ
├── build :make livehtml/buildhtmlのビルド結果格納
├── dev-notes :開発者用メモ
├── docker-build.sh :公式ルール用Dockerfile内で利用
├── docs :公式ルール用Dockerfile内でマウントし結果を出力
├── make.bat :windows用makeファイル。未使用、未メンテナンス
├── node_modules :node.jsでダウンロードされたライブラリ郡
├── out :plantumlで画像出力した際の出力先
├── redpen :文書検証ツールredpen関連の設定など格納
├── requirements.txt :pythonの必要ライブラリ郡
├── source :BlackPoker公式ルール
│ ├── _static :静的ファイル
│ ├── _templates :レイアウトテンプレート
│ ├── appendix :章（付録）
│ ├── common :章（共通ルール）
│ ├── conf.py :sphinx設定ファイル
│ ├── core :章（コアルール）
│ ├── format :章（フォーマット）
│ ├── index.rst :章（目次）
│ ├── init :章（はじめに）
│ └── match-regulations :章（対戦レギュレーション）
└── tools :ツール関連
└── actionlist :アクションリスト、エクストラリスト生成ツール
├── Dockerfile :GitHubActionsのrefresh_docsより実行されている。
├── README.md :actionlistツールの説明
├── base-docker :actionlist-base用Dockerイメージ。actionlist/Dockerfileにて使用。
├── docker-resource :Dockerfile内で利用するリソースファイル
├── original :アクションリスト、エクストラリスト定義
│ ├── act.yaml :アクションリスト定義
│ ├── extra.yaml :エクストラリスト定義
│ └ ...
├── pom.xml :ツール用pom.xml
├── python :pythonツール
├── src
│ ├── main
│ │ ├── java :ツール用javaソース
│ │ └── resources :velocityテンプレート
│ └── test :テストケース
├── target :ビルド結果
├── tex :生成されたtexファイル
└── web-site :生成されたHTMLファイル