Change documentation to Github Pages - #191
Merged
Merged
Conversation
Use the maintained Sphinx build layout while keeping documentation CI separate from the test matrix.
Publish strict Sphinx builds from master through GitHub Pages, matching the Psydac documentation workflow. Update project links and remove the obsolete Read the Docs configuration. Addresses #166.
Build the documentation when pull requests are opened, reopened, or synchronized, in addition to ready-for-review transitions.
Restore the detailed multipatch orientation reference and connectivity examples that were removed while repairing the documentation build.
Keep the full multipatch connectivity notes while marking their example as a Python code block so strict documentation builds remain warning-free.
FrederikSchnack
force-pushed
the
update_docs
branch
from
October 1, 2026 08:47
275bd56 to
c830042
Compare
yguclu
requested changes
Oct 1, 2026
yguclu
left a comment
yguclu
left a comment
Member
There was a problem hiding this comment.
Good job! I have a couple of comments
Co-authored-by: Yaman Güçlü <yaman.guclu@gmail.com>
Co-authored-by: Yaman Güçlü <yaman.guclu@gmail.com>
Co-authored-by: Yaman Güçlü <yaman.guclu@gmail.com>
Co-authored-by: Yaman Güçlü <yaman.guclu@gmail.com>
Co-authored-by: Yaman Güçlü <yaman.guclu@gmail.com>
yguclu
requested changes
Oct 1, 2026
Contributor
Author
Done in 4421d79. I will add it for the following PRs as well when we get to them. |
yguclu
requested changes
Oct 1, 2026
yguclu
approved these changes
Oct 1, 2026
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
2 participants
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.
Summary
This is the second PR for the general SymPDE improvements.
Modernize SymPDE’s documentation infrastructure and migrate hosted documentation to GitHub Pages. Closes #166.
Changes
Repair the Sphinx configuration so documentation builds cleanly with warnings treated as errors.
Add a dedicated documentation workflow based on the maintained Psydac setup.
Run documentation checks when pull requests are opened, reopened, synchronized, or marked ready for review.
Build the documentation with:
python -m sphinx -W --keep-going -b html doc doc/_build/htmlConfigure GitHub Pages artifact creation and deployment.
Restrict deployment to pushes to master; pull requests only build and validate the documentation.
Remove the obsolete Read the Docs configuration.
Update the documentation badge and project URL to point to GitHub Pages.
Correct documentation and docstring issues exposed by strict Sphinx builds.
Required GitHub repository configuration
With this PR, a repository administrator must enable GitHub Pages deployment through GitHub Actions:
No publishing branch or directory needs to be selected. The workflow uploads the generated HTML as a Pages artifact and deploys it through the github-pages environment.