ryan/libdpf
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Checkpoint the party/runtime stack before share-program and malicious-mode work.

Browse source 
Ship the TLS mesh, composer, Beaver/Yao/leaf MPC, prep/online paths, apps, and docs so the tree is pushable before elevating share_expr, security_mode, and prep resume.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
Ryan Henry 2026-09-28 05:59:19 -06:00
parent 695f8e84f7
commit 0d22946a0e
1835 changed files with 170291 additions and 2849 deletions
Download patch file Download diff file Expand all files Collapse all files

41
thirdparty/doxygen-awesome-css/docs/customization.md vendored
View file

@ -5,20 +5,22 @@
## CSS-Variables
This theme is highly customizable because a lot of things are parameterized with CSS variables.
This theme is highly customizable because many aspects are parameterized with CSS variables.
Just to give you an idea on how flexible the styling is, click this button:
To give you an idea of how flexible the styling is, click this button:
<div class="alter-theme-button" onclick="toggle_alternative_theme()" onkeypress="if (event.keyCode == 13) toggle_alternative_theme()" tabindex=0>Alter theme</div>
<div class="primary-button" onclick="toggleThemeVariant()" onkeypress="if (event.keyCode == 13) toggleThemeVariant()" tabindex=0>Alter theme</div>
<br><hr>
### Setup
It is recommended to add your own `custom.css` and overwrite the variables there:
It is recommended to add your own `custom.css` and override the variables there:
```
HTML_EXTRA_STYLESHEET = doxygen-awesome.css custom.css
```
Make sure to override the variables in the correct spot. All variables should be customized where they have been defined, in the `html` tag selector:
Make sure to override the variables in the correct place. All variables should be customized where they have been defined, in the `html` tag selector:
```css
html {
@ -26,7 +28,7 @@ html {
}
```
For dark-mode overrides you have to choose where to put them, depending on whether the dark-mode toggle extension is installed or not:
For dark-mode overrides, you have to choose where to put them, depending on whether the dark-mode toggle extension is installed or not:
<div class="tabbed">
@ -50,7 +52,7 @@ For dark-mode overrides you have to choose where to put them, depending on wheth
### Available variables
The following list gives an overview of the variables defined in [`doxygen-awesome.css`](https://github.com/jothepro/doxygen-awesome-css/blob/main/doxygen-awesome.css).
The following list provides an overview of the variables defined in [`doxygen-awesome.css`](https://github.com/jothepro/doxygen-awesome-css/blob/main/doxygen-awesome.css).
The list is not complete. To explore all available variables, have a look at the CSS starting from [here](https://github.com/jothepro/doxygen-awesome-css/blob/main/doxygen-awesome.css#L30).
All variables are defined at the beginning of the stylesheet.
@ -69,10 +71,11 @@ All variables are defined at the beginning of the stylesheet.
| `--spacing-small` | `5px` | |
| `--spacing-medium` | `10px` | |
| `--spacing-large` | `16px` | |
| `--spacing-xlarge` | `20px` | |
| **Border Radius**:<br>border radius for all rounded ui components. Will affect many components, like dropdowns, memitems, codeblocks, ... |||
| `--border-radius-small` | `4px` | |
| `--border-radius-medium` | `6px` | |
| `--border-radius-large` | `8px` | |
| `--border-radius-small` | `5px` | |
| `--border-radius-medium` | `8px` | |
| `--border-radius-large` | `10px` | |
| **Content Width**:<br>The content is centered and constrained in its width. To make the content fill the whole page, set the following variable to `auto`. |||
| `--content-maxwidth` | `1000px` | |
| **Code Fragment Colors**:<br>Color-Scheme of multiline codeblocks |||
@ -90,11 +93,11 @@ If you miss a configuration option or find a bug, please consider [opening an is
The theme overrides most colors with the `--primary-color-*` variables.
But there is a few small images and graphics that the theme cannot adjust or replace. To make these blend in better with
But there are a few small images and graphics that the theme cannot adjust or replace. To make these blend in better with
the rest, it is recommended to adjust the [doxygen color settings](https://www.doxygen.nl/manual/customize.html#minor_tweaks_colors)
to something that matches the chosen color-scheme.
to something that matches the chosen color scheme.
For the default color-scheme, these values work out quite well:
For the default color scheme, these values work out quite well:
```
# Doxyfile
@ -105,11 +108,15 @@ HTML_COLORSTYLE_GAMMA = 113
## Share your customizations
If you customized the theme with custom colors, spacings, font-sizes, etc. and you want to share your creation with others, you can to this [here](https://github.com/jothepro/doxygen-awesome-css/discussions/13).
If you have customized the theme with custom colors, spacings, font-sizes, etc. and you want to share your creation with others, you can do this [here](https://github.com/jothepro/doxygen-awesome-css/discussions/13).
I am always curious to learn about how you made the theme look even better!
<span class="next_section_button">
Read Next: [Tips & Tricks](tricks.md)
</span>
<div class="section_buttons">
| Previous | Next |
|:----------------------------|---------------------------:|
| [Extensions](extensions.md) | [Tips & Tricks](tricks.md) |
</div>

154
thirdparty/doxygen-awesome-css/docs/extensions.md vendored
View file

@ -2,10 +2,10 @@
[TOC]
On top of the base theme provided by `doxygen-awesome.css`, this repository comes with Javascript extensions that require additional setup steps to get them running.
In addition to the base theme provided by `doxygen-awesome.css`, this repository comes with JavaScript extensions that require additional setup steps to get them running.
The extensions require customizations in the header HTML-template.
This is how you can create the default template with Doxygen:
The extensions require customizations in the header HTML template.
Here is how you can create the default template with Doxygen:
1. Create default header template:
```sh
@ -21,10 +21,12 @@ This is how you can create the default template with Doxygen:
## Dark Mode Toggle {#extension-dark-mode-toggle}
Adds a button next to the search bar to enable and disable the dark theme variant manually:
Adds a button next to the search bar to manually enable and disable the dark theme variant:
<div class="darkmode_inverted_image bordered_image">
<img width=250 src="darkmode_toggle.png" />
![](img/darkmode_toggle.png){width=250px}
</div>
### Installation
@ -53,7 +55,7 @@ Changing the tooltip of the button:
DoxygenAwesomeDarkModeToggle.title = "Zwischen hellem/dunklem Modus wechseln"
```
Changing Icons. Both Emoji or SVG icons are supported:
Changing icons: Both Emoji and SVG icons are supported:
```js
DoxygenAwesomeDarkModeToggle.lightModeIcon = '🌞'
// icon from https://fonts.google.com/icons
@ -62,19 +64,21 @@ DoxygenAwesomeDarkModeToggle.darkModeIcon = `<svg xmlns="http://www.w3.org/2000/
All customizations must be applied before calling `DoxygenAwesomeDarkModeToggle.init()`!
## Fragment Copy Button {#extension-copy-button}
Shows a copy button when the user hovers over a code fragment:
<div class="darkmode_inverted_image bordered_image">
<img width=490 src="fragment_copy_button.png"/>
![](img/fragment_copy_button.png){width=490}
</div>
### Installation
1. Add the required resources in your `Doxyfile`:
- **HTML_EXTRA_FILES:** `doxygen-awesome-fragment-copy-button.js`
- **HTML_COPY_CLIPBOARD:** `NO` required with Doxygen >= 1.10.0
2. In the `header.html` template, include `doxygen-awesome-fragment-copy-button.js` at the end of the `<head>` and then initialize it:
```html
<html>
@ -105,10 +109,12 @@ All customizations must be applied before calling `DoxygenAwesomeDarkModeToggle.
## Paragraph Linking {#extension-para}
Provides a button on hover behind every headline to allow easy creation of a permanent link to the headline:
Provides a button that appears on hover behind every headline, allowing easy creation of a permanent link to the headline:
<div class="darkmode_inverted_image bordered_image">
<img width=220 src="paragraph_link.png"/>
![](img/paragraph_link.png){width=220}
</div>
Works for all headlines and for many documentation section titles.
@ -133,11 +139,13 @@ Works for all headlines and for many documentation section titles.
### Customizing
The button tooltip can be changed:
```js
DoxygenAwesomeParagraphLink.title = "Abschnitt verknüpfen"
```
The icon of the button can be changed. Both plain characters or SVG icons are supported:
The icon of the button can be changed. Both plain characters and SVG icons are supported:
```js
DoxygenAwesomeParagraphLink.icon = "¶"
```
@ -146,17 +154,18 @@ All customizations must be applied before calling `DoxygenAwesomeParagraphLink.i
## Interactive TOC {#extension-toc}
On large screens the Table of Contents (TOC) is anchored on the top right of the page. This extension visualizes the reading progress by dynamically highlighting the currently active section.
On small screens the extension hides the TOC by default. The user can open it manually when needed:
On large screens, the Table of Contents (TOC) is anchored at the top right of the page. This extension visualizes the reading progress by dynamically highlighting the currently active section.
On small screens, the extension hides the TOC by default. The user can open it manually when needed:
<div class="darkmode_inverted_image bordered_image">
<img width=380 src="interactive_toc_mobile.png" />
![](img/interactive_toc_mobile.png){width=380}
</div>
### Installation
@note Starting from Doxygen Version 1.14.0, you have to specify `PAGE_OUTLINE_PANEL=NO` in your Doxyfile to use this extension.
1. Add the required resources in your `Doxyfile`:
- **HTML_EXTRA_FILES:** `doxygen-awesome-interactive-toc.js`
2. In the `header.html` template, include `doxygen-awesome-interactive-toc.js` at the end of the `<head>` and then initialize it:
@ -175,30 +184,32 @@ On small screens the extension hides the TOC by default. The user can open it ma
### Customizing
The offset for when a headline is considered active can be changed. A smaller value means that the headline of the section must be closer to the top of the viewport before it is highlighted in the TOC:
```js
DoxygenAwesomeInteractiveToc.topOffset = 45
```
Hiding the TOC on small screens can be disabled. It is still interactive and can be hidden by the user but will now be open by default:
```js
DoxygenAwesomeInteractiveToc.hideMobileMenu = false
```
## Tabs {#extension-tabs}
@note Experimental feature! Please report bugs [here](https://github.com/jothepro/doxygen-awesome-css/issues).
This extension allows to arrange list content in tabs:
<div class="tabbed">
- <b class="tab-title">Tab 1</b> This is the content of tab 1
- <b class="tab-title">Tab 2</b> This is the content of tab 2
- <b class="tab-title">Tab 1</b>
This is the content of tab 1
- <b class="tab-title">Tab 2</b>
This is the content of tab 2
1. it has a list
2. with multiple items
</div>
### Installation
1. Add the required resources in your `Doxyfile`:
@ -218,8 +229,8 @@ This extension allows to arrange list content in tabs:
### Usage
Each list that is supposed to be displayed as tabs has to be wrapped with the `tabbed` CSS class.
Each item in the list must start with an element that has the class `tab-title`. It will then be used as tab title.
Each list that is supposed to be displayed as tabs must be wrapped with the `tabbed` CSS class.
Each item in the list must start with an element that has the class `tab-title`. It will then be used as the tab title.
```md
<div class="tabbed">
@ -230,7 +241,98 @@ Each item in the list must start with an element that has the class `tab-title`.
</div>
```
<span class="next_section_button">
## Read the Docs search {#readthedocs-search}
Read Next: [Customization](customization.md)
</span>
Use search index from Read the Docs instead of the built-in doxygen search. This allows using search metrics from
Read the Docs and in general gives a better search experience.
A live example is available at [doxygen-awesome-css.readthedocs.io](https://doxygen-awesome-css.readthedocs.io/).
### Installation
1. Add the required resources in your `Doxyfile`:
- **HTML_EXTRA_FILES:** `doxygen-awesome-readthedocs-search.js`
- **HTML_EXTRA_STYLESHEET:** `doxygen-awesome-readthedocs-search.css`
- **SEARCHENGINE:** `YES`
- **SERVER_BASED_SEARCH:** `YES`
- **EXTERNAL_SEARCH:** `YES`
- **SEARCHENGINE_URL:** `https://<your-project>.readthedocs.io/` OR
- **SEARCHENGINE_URL:** `https://<your-custom-readthedocs-domain>/`
`SEARCHENGINE_URL` is only used when testing locally, otherwise the domain name is detected automatically.
When testing locally, search may not work without disabling CORS. This can be a security risk, so it is advised to
only test inside of Read the Docs.
2. In the `header.html` template, include `doxygen-awesome-readthedocs-search.js` at the end of the `<head>` and then initialize it:
```html
<html>
<head>
<!-- ... other metadata & script includes ... -->
<script type="text/javascript" src="$relpath^doxygen-awesome-readthedocs-search.js"></script>
<script type="text/javascript">
DoxygenAwesomeReadtheDocsSearch.init()
</script>
</head>
<body>
```
For the sidebar-only theme variant, initialize with left-aligned live results:
```html
<script type="text/javascript">
DoxygenAwesomeReadtheDocsSearch.init('leftAlign')
</script>
```
Read the Docs provides the project and version slugs automatically. To select the Read the Docs index used when
testing locally, provide fallback values during initialization:
```html
<script type="text/javascript">
DoxygenAwesomeReadtheDocsSearch.init('leftAlign', {
projectSlug: 'your-readthedocs-project',
versionSlug: 'latest'
})
</script>
```
## Page Navigation {#extension-page-navigation}
To allow users to easily navigate from one document to another, "Next" and "Previous" buttons can be added at the end of a Markdown document.
### Installation
The feature is included in the default `doxygen-awesome.css`. No additional stylesheets or scripts need to be added.
### Usage
The following conditions must be met for the feature to work properly:
- The navigation must be inside a Markdown table with 1-2 columns.
- The alignment of the column defines the alignment of the arrow on the navigation button.
- The table must be wrapped inside a `<div>` with the class `section_buttons`.
<div class="tabbed">
- <span class="tab-title">Code</span>
```md
<div class="section_buttons">
| Previous | Next |
|:------------------|----------------------------------:|
| [Home](README.md) | [Customization](customization.md) |
</div>
```
- <span class="tab-title">Result</span>
<div class="section_buttons">
| Previous | Next |
|:------------------|----------------------------------:|
| [Home](README.md) | [Customization](customization.md) |
</div>
</div>
<div class="section_buttons">
| Previous | Next |
|:------------------|----------------------------------:|
| [Home](README.md) | [Customization](customization.md) |
</div>

BIN
thirdparty/doxygen-awesome-css/docs/img/testimage.png vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 118 KiB

70
thirdparty/doxygen-awesome-css/docs/tricks.md vendored
View file

@ -4,7 +4,7 @@
## Diagrams with Graphviz {#tricks-graphviz}
To get the best looking class diagrams for your documentation, generate them with Graphviz as vector graphics with transparent background:
To get the best-looking class diagrams for your documentation, generate them with Graphviz as vector graphics and a transparent background:
```
# Doxyfile
@ -13,7 +13,7 @@ DOT_IMAGE_FORMAT = svg
DOT_TRANSPARENT = YES
```
In case `INTERACTIVE_SVG = YES` is set in the Doxyfile, all user-defined dotgraphs must be wrapped with the `interactive_dotgraph` CSS class in order for them to be rendered correctly:
If `INTERACTIVE_SVG = YES` is set in the Doxyfile, all user-defined dotgraphs must be wrapped with the `interactive_dotgraph` CSS class for them to be rendered correctly:
```md
<div class="interactive_dotgraph">
@ -23,30 +23,30 @@ In case `INTERACTIVE_SVG = YES` is set in the Doxyfile, all user-defined dotgrap
</div>
```
@note Both the default overflow scrolling behavior in this theme and the interactive editor enabled by `INTERACTIVE_SVG` are unsatisfying workarounds IMHO. Consider designing your graphs to be narrow enough to fit the page to avoid scrolling.
@note Both the default overflow scrolling behavior in this theme and the interactive editor enabled by `INTERACTIVE_SVG` are, in my opinion, unsatisfying workarounds. Consider designing your graphs to be narrow enough to fit the page to avoid scrolling.
## Disable Dark Mode {#tricks-darkmode}
If you don't want the theme to automatically switch to dark mode depending on the browser preference,
you can disable dark mode by adding the `light-mode` class to the html-tag in the header template:
you can disable dark mode by adding the `light-mode` class to the HTML tag in the header template:
```html
<html xmlns="http://www.w3.org/1999/xhtml" class="light-mode">
```
The same can be done to always enable dark-mode:
The same can be done to always enable dark mode:
```html
<html xmlns="http://www.w3.org/1999/xhtml" class="dark-mode">
```
@warning This only works if you don't use the dark-mode toggle extension.
@warning This only works if you do not use the dark-mode toggle extension.
## Choosing Sidebar Width {#tricks-sidebar}
If you have enabled the sidebar-only theme variant, make sure to carefully choose a proper width for your sidebar.
It should be wide enough to hold the icon, project title and version number. If the content is too wide, it will be
If you have enabled the sidebar-only theme variant, make sure to carefully choose an appropriate width for your sidebar.
It should be wide enough to hold the icon, project title, and version number. If the content is too wide, it will be
cut off.
```css
@ -65,12 +65,12 @@ TREEVIEW_WIDTH = 335
## Formatting Tables {#tricks-tables}
By default tables in this theme are left-aligned and as wide as required to fit their content.
Those properties can be changed for individual tables.
By default, tables in this theme are left-aligned and as wide as required to fit their content.
These properties can be changed for individual tables.
### Centering
Tables can be centered by wrapping them in the `<center>` HTML-tag.
Tables can be centered by wrapping them in the `<center>` HTML tag.
<div class="tabbed">
@ -97,7 +97,7 @@ Tables can be centered by wrapping them in the `<center>` HTML-tag.
To make tables span the full width of the page, no matter how wide the content is, wrap the table in the `full_width_table` CSS class.
@warning Apply with caution! This breaks the overflow scrolling of the table. Content might be cut of on small screens!
@warning Apply with caution! This breaks the overflow scrolling of the table. Content might be cut off on small screens!
<div class="tabbed">
@ -118,7 +118,47 @@ To make tables span the full width of the page, no matter how wide the content i
</div>
<span class="next_section_button">
### Buttons
Read Next: [Example](https://jothepro.github.io/doxygen-awesome-css/class_my_library_1_1_example.html)
</span>
The theme comes with a custom class to add simple buttons:
<div class="tabbed">
- <span class="tab-title">Code</span>
```md
<div class="primary-button">Click me!</div>
```
- <span class="tab-title">Result</span>
<div class="primary-button">Click me!</div>
</div>
### Bordered Images
The `bordered_image` class can be used to add a neat rounded border around images in the documentation. With `darkmode_inverted_image` the image is filtered to adapt to darkmode:
<div class="tabbed">
- <span class="tab-title">Code</span>
```md
<div class="darkmode_inverted_image bordered_image">
![](img/testimage.png){width=250px}
</div>
```
- <span class="tab-title">Result</span>
<div class="darkmode_inverted_image bordered_image">
![](img/testimage.png){width=250px}
</div>
</div>
<div class="section_buttons">
| Previous | Next |
|:----------------------------------|---------------------------------------:|
| [Customization](customization.md) | [Example](https://jothepro.github.io/doxygen-awesome-css/class_my_library_1_1_example.html) |
</div>