ci: Add build docs step to PR workflows (and fix currently broken autodoc generation)#268
Merged
Merged
Conversation
7 tasks
FlorianDeconinck
approved these changes
Oct 16, 2025
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.
Description
PR #205 added basic support for auto-generated docs from docstrings. Docs aren't automatically generated and published yet. Recent changes such as removing
global_config.py, splittingGridSizerandSubGridSizer, or addingStatethus weren't captured in the docs. This PR suggest to improve the situation with two measuresThere's a discussion to have when we should start automatically publishing docs, see #269. In my opinion, this discussion is tangential because even if we automatically publish docs, we'd like to know if a PR would break building the docs.
We should also have a separate discussion about the structure of docs. This could fit nicely in the context of the package restructuring discussion, see #243.
How has this been tested?
The new workflow properly failed before adding the fixes, see here.
Checklist
N/A