AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO
Setup doctests to check Python snippets in docs
未关闭
Documentation
Feature Request
Needs Discussion
- 主要语言
- C++
- 星标
- 2.1k
- 派生
- 503
- PR 合并指标
- 30 天内没有已合并 PR
描述
Ideally #473 should have been caught by an automated tests (using doctest or similar)
http://www.sphinx-doc.org/en/stable/ext/doctest.html
贡献指南
调研方向
首先查看 issue #473 以及链接的 Sphinx doctest 文档,以了解报告的 Python 代码片段失败问题和建议的方案。找到文档构建的入口点,并确定应如何调用 doctest;当文档代码片段能够被自动检查并捕获报告的问题时,即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation, testing
- Issue 类型
- 功能
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100