Add CI check for mkdocs build - #3254
Open
oskooi wants to merge 2 commits into
Open
Conversation
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
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.
Added
.github/workflows/docs.yml:doc/**,mkdocs.yml, or the workflow itself (keeps it off unrelated pushes).doc/requirements.txt, and runsmkdocs buildPython_User_Interface.md).make docslocally covers it).Not implemented (possible feature to add separately)
Catching a stale committed
Python_User_Interface.md(docstrings changed but the generated file wasn't regenerated). This would require runningmake docsinsidebuild-ci.yml(where Meep is already compiled) and failing on a non-emptygit diff.