Add workflow for generating C++ docs with Doxygen on GitHub Pages#3597
Open
jessica-mitchell wants to merge 34 commits intonest:masterfrom
Open
Add workflow for generating C++ docs with Doxygen on GitHub Pages#3597jessica-mitchell wants to merge 34 commits intonest:masterfrom
jessica-mitchell wants to merge 34 commits intonest:masterfrom
Conversation
positive test -merge
Contributor
Author
|
Note that the CI run fails because the files that it needs are not yet in master |
terhorstd
reviewed
Jan 26, 2026
| .. listexamples:: iaf_psc_alpha | ||
|
|
||
| EndUserDocs */ | ||
|
|
terhorstd
reviewed
Jan 26, 2026
Co-authored-by: Dennis Terhorst <terhorstd@users.noreply.github.com>
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.
This PR creates a CI workflow that will deploy the doxygen C++ docs to GitHub Pages or create the output HTML as artifacts.
The workflow triggers in the following cases:
In this case GitHub pages is not deployed, but the html output from doxygen is uploaded as an artifact
The developer documentation workflow description has been updated to explain this new feature. A screenshot might be added in a future PR to help find the artifact.
The workflow is set up so we always use the Doxygen config file and the css that is in master; this allows us to modify the type of content and the layout at any time and the changes will be deployed for all versions of the documentation.
Currently only master, and the latest 2 releases of NEST are deployed. We want to keep it minimal to discourage old docs discovery and utilization.
@terhorstd mentioned we might need to consider adding the pynestkernel.pyx which can be done at a future PR; only cpp/h files are processed at the moment.