build: add Documentation linting step to CI - #35794
Conversation
|
Thanks for the pull request, @pomegranited! What's next?Please work through the following steps to get your changes ready for engineering review: 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. 🔘 Update the status of your PRYour PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:
When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
94eafce to
4e947a2
Compare
using sphinx-lint
4e947a2 to
1677777
Compare
|
Closing this PR as my CC time for this year has run out, and Sumac docs are building again :) |
Description
#32741 removed the documentation build step because it was taking > 40 minutes to run.
This PR adds a "documentation lint" step to the CI which uses sphinx-lint. This doesn't build the whole documentation tree, but should let PR creators know if they've made any code changes that break documentation.
This change affects Developers only.
Supporting information
See #35766 (comment) for more context.
Testing instructions
To verify that this added step helps us:
make docs-lintshould fail with the error reported in the referenced PR.Deadline
None