知识卡片

普通读书笔记卡 · 1958.c.12.a.1.lk · 生成模型:未记录

提取说明与执行示例分工不同

理解等级:中级

autodoc从可导入对象的docstring提取说明,doctest构建器则运行文档中的示例检查结果,原书末尾把前者说成自动提取doctest混淆了职责。autodoc可能导入模块并触发导入副作用,构建环境和依赖需安排;启用提取也不意味着代码示例已经测试或文档完全正确。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    参考来源

    - 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元019;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。 - 结论依据:原文将autodoc与doctest混称,本卡按已核对职责区分导入提取docstring与执行选定示例,启用前者不证明后者通过。补充核验入口:https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html。未在本机运行示例或改变环境。 - 原始内容:多的功能,你可以在其网站上发现。例如, autodoc 功能是自动提取你的 doctest 以构建文档的一个很好的选项。参考http://sphinx.pocoo.org。