Sphinxで作られているので、htmlをビルドにpipパッケージのインストールが必要だったり、
PDFを出力するにはLatex環境が必要だったりと環境を汚したくないorとりあえず結果がほしい人向け。
追記で日本語訳もしたのでその話も。
* 追記
のちに無事、本家に取り入れられました。
画面下部に言語セレクタがあるのでこれで切り替えてください。
下準備
nemtech/nem2-docs: nem2 (Catapult) official documentation
nem2-docsのリポジトリからまるっとクローンするかzipでダウンロードして展開してください。
44uk/nem2-docs-builder: build nem2-docs and output html, pdf
ここからファイルをダウンロードしてください。
- Dockerfile
- build.sh
- .dockerignore
この3つのファイルをnem2-docsのディレクトリへいれます。
ビルド
スクリプトを実行するだけです。
./build.sh
build/html
以下のディレクトリにファイルが生成されます。
PDFがほしい場合はlatexpdf
を渡します。
./build.sh latexpdf
build/latexpdf/nem2-docs.pdf
にファイルが生成されます。
出力設定
pdfの出力について設定したい場合はsource/conf.py
にlatex
に関わる設定があるので、その辺をお好みで変更してください。
とりあえず妙な空白ページが挿入されるのは、以下の設定を入れれば入らなくなります。
latex_elements = {
'extraclassoptions': 'report',
.
.
.
一通り目を通してみたのですが、画像の順序がおかしかったり、画像がはみ出してしまったりしていました。
preambleなどをいじってみましたがうまくいきませんでした…。
私はあまり詳しくないのでもっといい感じで出せるおすすめ設定があれば教えてほしいです。
国際化対応版
intl
ブランチにてコマンドをちょっと変えたものを公開しました。
これは、nem2-docsの日本語訳版でも使っているものですが、フォーマットと言語を渡せるようにしています。
この2つを使えば、日本語訳版のPDFも出力可能です。
あとは他の言語でも翻訳ファイル(*.po)が出揃ってくればどの言語でもこの方法で対応できそうです。
(sphinx-intlでの翻訳を公式に取り込んでもらうかはまだ悩んでいます。英語のドキュメント自体もまだ未完成のようなので)
画像のズレやはみ出しは相変わらず起こるので、source/conf.py
でいい感じの設定が必要みたいです。
また、日本語訳についてですが、一部記号が意図しないものに置き換わってしまっているようなので、その辺改善していきます。
本家ドキュメント自体まだまだ未完成のようですので、引き続き更新を追いかけていく予定です。