AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO
Setup doctests to check Python snippets in docs
Open
Documentation
Feature Request
Needs Discussion
- Dominant language
- C++
- Stars
- 2.1k
- Forks
- 503
- PR merge metrics
- No merged PRs in 30d
Description
Ideally #473 should have been caught by an automated tests (using doctest or similar)
http://www.sphinx-doc.org/en/stable/ext/doctest.html
Contributor guide
Research direction
Start by reviewing issue #473 and the linked Sphinx doctest documentation to understand the reported Python snippet failure and the proposed approach. Find the documentation build entry point and determine how doctests should be invoked; done means the documentation snippets are automatically checked and the reported problem is caught.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100