Repository navigation
Install mcpy in the docs workflow and run it on pull requests - #34
Merged
Merged
Conversation
The GitHub Pages docs job builds with -W, and it does not install the package either, so it failed with 37 "No module named 'mcpy'" warnings on the merge of #32. Same cause as the Read the Docs fix in the previous commit, different builder. It also ran only on pushes to main, which is why no pull request could ever catch it: the one place the docs are compiled with warnings as errors never saw a PR. It now runs on pull requests too, with the Pages upload, the deploy job and the Read the Docs trigger gated to non-PR events so nothing publishes from a branch.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Pages docs job builds with
-W, and it never installs the package, sosphinx.ext.autodoccannot importmcpy. Every push to main since #32 failedwith 37
No module named 'mcpy'warnings. #33 fixed the same cause on the Readthe Docs side only, which is why main still fails.
It also ran only on pushes to main, so no pull request could catch it: the one
place the docs are compiled with warnings as errors never saw a PR. Now:
pip install .alongside sphinx and the theme,pull_requestas well,non-PR events, so nothing publishes from a branch.
Verified locally with the exact CI command in a clean env holding only sphinx,
sphinx_rtd_theme==3.0.1,myst_parser==3.0.1and mcpy:The same env without mcpy reproduces the 37 warnings.