Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • D dynamorio
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 1,467
    • Issues 1,467
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 44
    • Merge requests 44
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • DynamoRIO
  • dynamorio
  • Merge requests
  • !4748

i#4111: Generate doxygen suitable for embedding in jekyll

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Derek Bruening requested to merge i4111-merge-docs into master Feb 21, 2021
  • Overview 2
  • Commits 7
  • Pipelines 0
  • Changes 6

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

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: i4111-merge-docs