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。Web 服务器可将 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
这会固定构建时间。可重复性还取决于源文件、模板、字体、编译器版本和资源。只固定时钟还不够。
构建成功后发布完整目录。进程成功退出是必要条件;修改模板后仍需视觉检查。