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

* 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

doc/doxygen/DoxygenLayout.xml

@@ -7,7 +7,7 @@
         <tab type="pages" visible="yes" title="" intro=""/>
         <tab type="topics" visible="yes" title="" intro=""/>
         <tab type="usergroup" title="Code Reference">
-            <tab type="modules" visible="yes" title="" intro="">
+            <tab type="modules" visible="no" title="" intro="">
                 <tab type="modulelist" visible="yes" title="" intro=""/>
                 <tab type="modulemembers" visible="yes" title="" intro=""/>
             </tab>
@@ -15,9 +15,8 @@
                 <tab type="namespacelist" visible="yes" title="" intro=""/>
                 <tab type="namespacemembers" visible="yes" title="" intro=""/>
             </tab>
-            <tab type="concepts" visible="yes" title="">
-            </tab>
-            <tab type="interfaces" visible="yes" title="">
+            <tab type="concepts" visible="no" title=""/>
+            <tab type="interfaces" visible="no" title="">
                 <tab type="interfacelist" visible="yes" title="" intro=""/>
                 <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
                 <tab type="interfacehierarchy" visible="yes" title="" intro=""/>
@@ -28,11 +27,11 @@
                 <tab type="hierarchy" visible="yes" title="" intro=""/>
                 <tab type="classmembers" visible="yes" title="" intro=""/>
             </tab>
-            <tab type="structs" visible="yes" title="">
+            <tab type="structs" visible="no" title="">
                 <tab type="structlist" visible="yes" title="" intro=""/>
                 <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
             </tab>
-            <tab type="exceptions" visible="yes" title="">
+            <tab type="exceptions" visible="no" title="">
                 <tab type="exceptionlist" visible="yes" title="" intro=""/>
                 <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
                 <tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
@@ -41,7 +40,7 @@
                 <tab type="filelist" visible="yes" title="" intro=""/>
                 <tab type="globals" visible="yes" title="" intro=""/>
             </tab>
-            <tab type="examples" visible="yes" title="" intro=""/>
+            <tab type="examples" visible="no" title="" intro=""/>
         </tab>
     </navindex>
 

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
+```
+
+<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.

doc/doxygen/css/cockatrice_docs_style.css

@@ -0,0 +1,33 @@
+/*
+
+See "Awesome Doxygen CSS" theme docs:
+https://jothepro.github.io/doxygen-awesome-css/md_docs_2customization.html#autotoc_md36
+
+Adjustments here are based on the css file of the theme and variables defined there.
+
+*/
+
+
+/* Light Mode overrides */
+html {
+    --primary-color: #33a946;
+    --primary-dark-color: #33a946;
+    --primary-light-color: #33a946;
+}
+
+/* Dark Mode overrides */
+@media (prefers-color-scheme: dark) {
+    html:not(.light-mode) {
+        --primary-color: #33a946;
+        --primary-dark-color: #33a946;
+        --primary-light-color: #33a946;
+    }
+}
+
+/* Dark Mode overrides, defined twice to support both the dark-mode without and with doxygen-awesome-darkmode-toggle.js */
+html.dark-mode {
+    color-scheme: dark;
+    --primary-color: #33a946;
+    --primary-dark-color: #33a946;
+    --primary-light-color: #33a946;
+}

doc/doxygen/css/hide_nav_sync.css

@@ -0,0 +1,10 @@
+/* hide navigation sync control and icons */
+#nav-sync,
+#nav-sync * {
+    display: none !important;
+}
+
+div.nav-sync-icon,
+div.nav-sync-icon * {
+    display: none !important;
+}

doc/doxygen/extra-pages/index.md

@@ -1,10 +1,8 @@
-@mainpage Cockatrice Documentation
+@mainpage Documentation
 
-# Welcome
+Welcome to the Cockatrice code documentation.
 
-This is the **main landing page** of the Cockatrice documentation.
+- @subpage user_reference
+- @subpage developer_reference
 
-- Go to the @subpage user_reference page
-- Review the @subpage developer_reference
-
-Or check out the <a href="https://cockatrice.github.io/" target="_blank" rel="noopener noreferrer">Cockatrice Webpage</a>.
+Please also check the <a href="https://cockatrice.github.io/" target="_blank" rel="noopener noreferrer">Cockatrice Webpage</a> or our <a href="https://github.com/Cockatrice/Cockatrice" target="_blank" rel="noopener noreferrer">Code Repository</a> for general information.

doc/doxygen/extra-pages/user_documentation/index.md

@@ -1,17 +1,17 @@
 @page user_reference User Reference
  
-# Deck Management
+## Deck Management
 
 - @subpage creating_decks
 - @subpage importing_decks
 - @subpage editing_decks
 - @subpage exporting_decks
 
-# Release Channels
+## Release Channels
 
 - @subpage beta_release
 
-# Syntax Help
+## Syntax Help
 
 - @subpage search_syntax_help
-- @subpage deck_search_syntax_help
+- @subpage deck_search_syntax_help

doc/doxygen/theme

@@ -0,0 +1 @@
+Subproject commit 1f3620084ff75734ed192101acf40e9dff01d848