jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-06-24 15:43:54 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs: Use doxygen-awesome-css theme (#6512)

Browse source 
* add doxygen-theme-css submodule

* enable theme and disable not needed code references

* hide nav sync button

* css and cleanup

* Move comments to dedicated README to not fail config check
This commit is contained in:
tooomm 2026-01-24 11:22:43 +01:00 • committed by GitHub
parent 12b5525a2d
commit 2b372c14e4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 86 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/doxygen/README.md Normal file
View file

@ -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
```
<br>
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.