Guidedog / 文档 0.2.0

关于本手册¶

本手册介绍已经实现的工具，以及有意保留的限制。独立的 GDS 项目记录提案、决策和评审历史。改善排版并不会改变提案的状态。

本手册按实际使用过程组织：通过教程入门，通过专题理解原理，通过操作指南完成任务，再查阅参考资料核对细节。内部实现部分解释不变量和证明。

行文以小例子、明确的假设和直接的陈述为主。目标是让读者能够检验解释是否成立。页面采用克制的配色、醒目的标题、适合阅读的衬线字体，以及易于使用的导航。它并不模仿任何作者的措辞或版式。

本项目通过 guidedog quickstart 创建，并由 Guidedog 构建。正文使用 RST，图表使用 Graphviz，公式使用 LaTeX 数学记法。只有 PDF 排版模板仍使用 Typst。

构建验证记录¶

2026-10-01 的远程验证对 CPython、Django 和 Flask 分别进行了全新及增量 HTML、PDF 构建。十二条命令全部成功，诊断和链接检查结果与既有基线一致。Linux 测试通过 1,039 项，定向 sanitizer 测试通过 94 项。这些结果只证明所测试版本的行为，并不表示完全兼容 Sphinx。已知限制见与 Sphinx 的兼容性。

文档维护命令见维护本项目的文档。