Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Downgrade Doxygen to 1.10.0 and update theme #6978

Merged
merged 2 commits into from
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/.styleguide
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
generatedFileExclude {
theme.css
}
9 changes: 8 additions & 1 deletion docs/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,13 @@ doxygen {
// Doxygen binaries are only provided for x86_64 platforms
// Other platforms will need to provide doxygen via their system
// See below maven and https://doxygen.nl/download.html for provided binaries
// Ensure theme.css (from https://github.com/jothepro/doxygen-awesome-css) is compatible with
// doxygen version when updating

String arch = System.getProperty("os.arch");
if (arch.equals("x86_64") || arch.equals("amd64")) {
executables {
doxygen version : '1.12.0',
doxygen version : '1.10.0',
baseURI : 'https://frcmaven.wpi.edu/artifactory/generic-release-mirror/doxygen'
}
}
Expand Down Expand Up @@ -142,6 +144,9 @@ doxygen {
exclude 'units/**'
}

//TODO: building memory docs causes search to break
exclude 'wpi/memory/**'

exclude '*.pb.h'

// Save space by excluding protobuf and eigen
Expand All @@ -163,10 +168,12 @@ doxygen {
extract_static true
file_patterns '*'
full_path_names true
full_sidebar false
generate_html true
generate_latex false
generate_treeview true
html_extra_stylesheet 'theme.css'
html_colorstyle 'LIGHT'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So that doxygen doesn't interfere with the theme's switching. jothepro/doxygen-awesome-css#97

html_timestamp true
javadoc_autobrief true
project_name 'WPILibC++'
Expand Down
Loading
Loading