pytest-dev / pytest-dev/pytest
Add regendoc to CI?
Open
Nobody has claimed this yet.
type: docs
type: infrastructure
- Dominant language
- Python
- Stars
- 14.5k
- Forks
- 3.4k
- Avg merge
- 2d 9h
- Merged PRs (30d)
- 35
Description
Looking at #8807 apparently we don't run regendoc on CI? It seems to me like we should, and not only run it on releases.
Perhaps we should even enforce that regendocs runs through without any diff, i.e. that any possible changes in the generated docs should be part of the PR diff?
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
Read #8807 first, then inspect the existing release-only regendoc setup and CI configuration. Define a CI check that runs regendoc and fails when generated documentation differs; verify that the check captures generated changes in the pull request diff.
Written by the indexing model from the issue text.
Assessment
- Domain
- ci-cd
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100