From d1eaf8a99c90a3b6403667982b4b79f69efaccfc Mon Sep 17 00:00:00 2001 From: tooomm Date: Sun, 18 Jan 2026 17:52:24 +0100 Subject: [PATCH] Move comments to dedicated README to not fail config check --- Doxyfile | 6 +++--- doc/doxygen/README.md | 14 ++++++++++++++ 2 files changed, 17 insertions(+), 3 deletions(-) create mode 100644 doc/doxygen/README.md diff --git a/Doxyfile b/Doxyfile index b165fe030..0f2642fd8 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1457,7 +1457,7 @@ HTML_EXTRA_FILES = doc/doxygen/js/graph_toggle.js # The default value is: AUTO_LIGHT. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_COLORSTYLE = LIGHT # required with doxygen-awesome-css theme, Auto Dark Mode will still work +HTML_COLORSTYLE = LIGHT # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to @@ -1768,7 +1768,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -DISABLE_INDEX = NO # YES is bugged in the theme, see jothepro/doxygen-awesome-css/issues/201 +DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag @@ -1806,7 +1806,7 @@ PAGE_OUTLINE_PANEL = YES # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -FULL_SIDEBAR = NO # required for doxygen-awesome-css theme +FULL_SIDEBAR = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # Doxygen will group on one line in the generated HTML documentation. diff --git a/doc/doxygen/README.md b/doc/doxygen/README.md new file mode 100644 index 000000000..988147159 --- /dev/null +++ b/doc/doxygen/README.md @@ -0,0 +1,14 @@ +## Doxygen Documentation Theme + +Required changes to the `Doxyfile` config from the [theme docs](https://jothepro.github.io/doxygen-awesome-css/index.html#autotoc_md16) to make [doxygen-awesome-css](https://github.com/jothepro/doxygen-awesome-css) work: +``` +HTML_EXTRA_STYLESHEET = doxygen-awesome.css # Main CSS file of the theme +GENERATE_TREEVIEW = YES # Optional, also works without +HTML_COLORSTYLE = LIGHT # Required with doxygen-awesome-css theme, Auto Dark Mode will still work +DISABLE_INDEX = NO # YES is bugged in the theme, see jothepro/doxygen-awesome-css/issues/201 +FULL_SIDEBAR = NO # Required for doxygen-awesome-css theme +``` + +
+ +Cockatrice dedicated color adjustments are configured in the [cockatrice_docs_style.css](https://github.com/Cockatrice/Cockatrice/blob/master/doc/doxygen/css/cockatrice_docs_style.css) file that uses & overrides the theme definitions.