pymc-devs / pymc-devs/pytensor
Run doctests on the docs
Open
Nobody has claimed this yet.
docs
GitHub CI/CD
help wanted
tests
- Dominant language
- Python
- Stars
- 644
- Forks
- 208
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 16
Description
Description
I thought this would be straightforward but we may need something like https://sybil.readthedocs.io/en/latest/quickstart.html
My default use of pytest --doctest-modules --doctest-glob='.*rst' only works if I specify the docs files manually which isn't great.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the documented command, pytest --doctest-modules --doctest-glob='.*rst', and inspect how the docs are discovered when files must be specified manually. Read the linked Sybil quickstart for a possible approach. Done means the repository's documentation files are discovered and their doctests run without manual file selection.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing-qa
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100