Guidedog / 文档
0.2.0
为代码库生成文档¶
公开名称需要契约。说明输入、结果、所有权和失败条件。只有签名，不能算手册。
Odin¶
odin_autoapi_dirs = ["../../lib"]
odin_autoapi_root = "api"
odin_autoapi_options = ["members", "undoc-members"]
Guidedog 通过 Odin 的解析器读取源代码，不编译或运行被记录的包。生成的页面加入文档图和对象清单。本仓库的独立 API 项目是 docs/api。指令、签名和选项见 为 Odin 生成文档。
Python¶
extensions = ["sphinx.ext.autodoc"]
autodoc_source_paths = ["../src"]
Guidedog 解析 Python 源代码，而不导入模块，以避免导入产生副作用。运行时生成的对象因此可能缺失。若它们属于公开接口，应显式记录。准确的发现规则见 用 autodoc 编写 Python 文档。
跨项目链接¶
将生成的 objects.inv 随网站一起发布。其他项目即可通过 intersphinx 映射解析名称。为实现可重复构建，应显式设置映射。见 链接到其他项目。