i#4111: Generate doxygen suitable for embedding in jekyll #4748
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
Creates a second version of the doxygen html output suitable for embedding in our jekyll-based web site. This version turns off the doxygen treeview, but then borrows the javascript menu files from the treeview version. We then edit the html to remove the headers, and edit the menu files for inlining into our web site's single array. Furthermore, we generate keyword search term data so that searches using lunr for functions or types result in direct links to their anchors within their pages. It generates keyword tokens for each component of an underscore-separated multi-word type, along with tokens for each prefix (e.g., so that "dr_mutex" will find "dr_mutex_*"). Adds installation into a "docs_embed" directory. Adds deployment logic to package.cmake to copy the embedded html to a top level "html_embed", along with new steps in the ci-package GA workflow to take the embedded html files and push them to the dynamorio.github.io repository. Issue: #4111
…is not present in older doxygen
|
This should also reference #4740 as it generates keywords for prefixes like |
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.
Creates a second version of the doxygen html output suitable for
embedding in our jekyll-based web site. This version turns off the
doxygen treeview, but then borrows the javascript menu files from the
treeview version. We then edit the html to remove the headers, and
edit the menu files for inlining into our web site's single array.
Furthermore, we generate keyword search term data so that searches
using lunr for functions or types result in direct links to their
anchors within their pages. It generates keyword tokens for each
component of an underscore-separated multi-word type, along with
tokens for each prefix (e.g., so that "dr_mutex" will find
"dr_mutex_*").
Adds installation into a "docs_embed" directory.
Adds deployment logic to package.cmake to copy the embedded html to a
top level "html_embed", along with new steps in the ci-package GA
workflow to take the embedded html files and push them to the
dynamorio.github.io repository.
Issue: #4111