Add to Doxygen pages, and use doxygen as a CI check. #231
Conversation
This file contains 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
samcunliffe
force-pushed
the
readme-and-contributing-into-main-page-230
branch
from
d6fa2c6 to
77febc9
Compare
samcunliffe
changed the title
Remove the copy of images.
samcunliffe
added
documentation
willGraham01
approved these changes
Feb 23, 2023
Comment on lines
+3
to
+8
| # Generate the documentation on all merges to main, all pull requests, or by | ||
| # manual workflow dispatch. The Doxygen job can be used as a CI check that all | ||
| # functions are documented. The publish job only runs on new commits to the main | ||
| # branch and actually pushes the generated html to the gh-pages branch (which | ||
| # triggers a GitHub pages deployment). When things are a bit more stable, we can | ||
| # only publish the website on release tags. |
willGraham01
pushed a commit
that referenced
this pull request
Mar 6, 2023
* Add README and CONTRIBUTING.md to the doxygen pages. * Split workflow into two jobs. Fix README inclusion. * Don't need that yet. Remove the copy of images.
willGraham01
pushed a commit
that referenced
this pull request
Mar 7, 2023
* Add README and CONTRIBUTING.md to the doxygen pages. * Split workflow into two jobs. Fix README inclusion. * Don't need that yet. Remove the copy of images.
willGraham01
pushed a commit
that referenced
this pull request
Mar 29, 2023
* Add README and CONTRIBUTING.md to the doxygen pages. * Split workflow into two jobs. Fix README inclusion. * Don't need that yet. Remove the copy of images.
1 task
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 is the first part of #230. It makes three changes:
<details>HTML tags.doxygenandpublish. This has a couple of benefits...main, but it could be release tags (for example).In particular for the first step, when we've got everything documented, we can set Doxygen to fail when it encounters an undocumented warning. This would then fail the CI.
Too many words? Here's a screenshot...
Next planned steps: