Guidedog / ドキュメント
0.2.0
文書のビルドと公開¶
通常の出力ディレクトリにビルドします。
guidedog build html docs/manual -j auto -W
guidedog build pdf docs/manual -W
サイトは docs/manual/_build/html、PDF と生成した Typst ソースは docs/manual/_build/pdf にある。HTML は静的ファイルとして配信でき、本番環境に Odin サーバーは不要。
出力先の選択¶
Sphinx 形式ではソースと出力先を明示します。
guidedog build -b html docs/manual build/manual-site -W
出力はソースの外に置く。公開によってソースツリーを置き換える配置は Guidedog が拒否する。独自の出力先は build/.manual-site.guidedog/.doctrees のような同階層の安定したキャッシュを使うため、公開ディレクトリーには公開物だけが入る。
プレビューと検査¶
guidedog serve docs/manual
guidedog build dummy docs/manual -n -W
dummy ビルダーはプロジェクトを読み、参照を解決するが公開物を作らない。意味の簡易チェックに使える。最終レイアウトのテストにはならない。
再現可能な時刻¶
SOURCE_DATE_EPOCH=1790812800 guidedog build html docs/manual -W
これでビルド時刻を固定する。再現性はソース、テンプレート、フォント、コンパイラーの版、リソースにも依存する。時刻の固定だけでは足りない。
ビルド成功後にディレクトリー全体を公開する。正常終了は必要だが、テンプレート変更後は見た目の確認も必要。