用途:该技能面向 microsoft/semantic-link-labs 项目,用于本地构建文档、校验 docstring 格式、检查文档警告或错误,以及确保新增函数具备完整文档。
主要能力:文档框架为 Sphinx 配合 numpydoc,主题使用 sphinx_rtd_theme,托管于 ReadTheDocs,源码位于 docs/source/,构建输出到 docs/build/html/,配置在 docs/source/conf.py。支持从源码生成 API 文档并构建 HTML。
使用方式:先安装依赖 pip install -r docs/requirements.txt;进入 docs 目录后执行 sphinx-apidoc -f -o source ../src/sempy_labs/ 生成 API 文档,再运行 make html(Windows 用 make.bat html),最后在浏览器打开 docs/build/html/index.html 预览。检查警告可用 make html 2>&1 | grep -i warning,清理重建用 make clean 与 make html。
docstring 规范:采用 numpydoc 风格,必需部分包括简短描述、Parameters、Returns;可选部分包括扩展描述、Raises、Examples、Notes、See Also。参数类型需与函数签名一致,使用 4 空格缩进,API 包装函数应附参考链接,支持服务主体认证的函数需注明。
限制:资料未提供该技能的收费、价格、平台兼容性细节或效果保证;具体构建结果取决于本地环境与依赖安装情况。