このページの内容

Guidedog / ドキュメント 0.2.0

このマニュアルについて

このマニュアルでは、実装済みの機能と意図的な制約を説明します。提案、決定、レビュー履歴は、別の GDS プロジェクトに記録します。組版を改善しても、提案の状態は変わりません。

実際の使い方に沿って構成しています。チュートリアルで学び、トピックガイドで理解し、手順ガイドで作業し、リファレンスで詳細を確認します。内部実装の章では、不変条件と証明を説明します。

小さな例を使い、前提を明示し、要点を直接述べます。読者が自分で確かめられる説明を目指しています。控えめな配色、明確な見出し、読みやすいセリフ体、使いやすいナビゲーションを採用しています。特定の著者の文章やレイアウトをまねるものではありません。

このプロジェクトは guidedog quickstart で作成し、Guidedog でビルドしています。本文は RST、図は Graphviz、数式は LaTeX の数学記法で記述します。Typst を使うのは PDF の組版テンプレートだけです。

ビルドの検証記録

2026-10-01 のリモート検証では、CPython、Django、Flask について HTML と PDF のクリーンビルドおよび増分ビルドを実行しました。12 個のコマンドがすべて成功し、診断とリンク検査の結果は既存の基準と一致しました。Linux のテスト 1,039 件と、対象を絞った sanitizer テスト 94 件が通りました。これは検証した版についての結果であり、Sphinx との完全互換性を示すものではありません。残る制約は Sphinx との互換性 を参照してください。

ドキュメントの保守に使うコマンドは この文書の保守 にまとめています。