chore: Fix documentation generation job: #5091
Merged
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
* Add "doxygen" to list of supported branches to allow for testing and development. * Add titles / H1 to some .md files that don't have them.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #5091 +/- ##
=======================================
Coverage 74.8% 74.8%
=======================================
Files 768 768
Lines 63134 63134
Branches 8869 8869
=======================================
+ Hits 47237 47241 +4
+ Misses 15897 15893 -4 see 3 files with indirect coverage changes |
ximinez
added
Documentation
thejohnfreeman
approved these changes
Aug 6, 2024
|
Thank you! |
intelliot
approved these changes
Aug 8, 2024
ximinez
added
the
Passed
vlntb
pushed a commit
to vlntb/rippled
that referenced
this pull request
Aug 23, 2024
* Add "doxygen" to list of supported branches to allow for testing and development. * Add titles / H1 to some .md files that don't have them.
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.
High Level Overview of Change
Updates the document generation config to work with the new physical code layout. Adds "doxygen" to list of supported branches to allow for testing and development. Adds titles / H1 to some .md files that don't have them.
See https://ximinez.github.io/rippled/ for what it could look like when merged.
Context of Change
The Build and publish Doxygen documentation job stopped working when e238488
was merged to
develop. It removed thesrc/README.mdfile. That file was unimportant, but it was referenced by the CMake and Doxygen configs for document generation.This PR removes references to that file, and generalizes the config to remove most references to individual files.
Finally, because I noticed that several of the links on the Related Pages list, which includes all the .md files, had generic titles, I added titles to those files.
Type of Change
.gitignore, formatting, dropping support for older tooling)Future Tasks
The Build and publish Doxygen documentation job is currently disabled. It can be reenabled just before this PR is merged.