-
Notifications
You must be signed in to change notification settings - Fork 385
Add workflow for generating C++ docs with Doxygen on GitHub Pages #3557
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jessica-mitchell
wants to merge
31
commits into
nest:master
Choose a base branch
from
jessica-mitchell:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
positive test -merge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
I: No breaking change
Previously written code will work as before, no one should note anything changing (aside the fix)
S: Normal
Handle this with default priority
T: Enhancement
New functionality, model or documentation
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.