Skip to content

Add CI check for mkdocs build - #3254

Open
oskooi wants to merge 2 commits into
NanoComp:masterfrom
oskooi:mkdocs_build_update
Open

Add CI check for mkdocs build#3254
oskooi wants to merge 2 commits into
NanoComp:masterfrom
oskooi:mkdocs_build_update

Conversation

@oskooi

@oskooi oskooi commented Jul 27, 2026

Copy link
Copy Markdown
Collaborator

Added .github/workflows/docs.yml:

  • Triggers only on changes to doc/**, mkdocs.yml, or the workflow itself (keeps it off unrelated pushes).
  • Checks out, sets up Python 3.11, installs doc/requirements.txt, and runs mkdocs build
  • This catches broken doc builds on every PR without having to compile Meep (it builds from the committed Markdown tree, which already includes the generated Python_User_Interface.md).
  • A comment documents the one thing it can't do — regenerate the API doc from docstrings (that needs a Meep build; make docs locally 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 running make docs inside build-ci.yml (where Meep is already compiled) and failing on a non-empty git diff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant