move doxygen files in one location

.github/CONTRIBUTING.md

@@ -1,4 +1,4 @@
-<!--! @page contributing Contributing -->
+@page contributing Contributing
 
 &nbsp; [Introduction](#contributing-to-cockatrice) | [Code Style Guide](
 #code-style-guide) | [Translations](#translations) | [Release Management](

.github/workflows/documentation-build.yml

@@ -6,32 +6,50 @@ on:
       - '*'   # Only re-generate docs when a new tagged version is pushed
   pull_request:
     paths:
+      - '**.h'
+      - '/doc/doxygen/**'
       - '.github/workflows/documentation-build.yml'
       - 'Doxyfile'
-      - 'doxygen_style.css'
   workflow_dispatch:
 
+env:
+  COCKATRICE_REF: ${{ github.ref_name }}    # Tag name if the commit is tagged, otherwise branch name
+
 jobs:
   docs:
     name: Doxygen
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout code
+      - name: Checkout
         uses: actions/checkout@v5
 
       - name: Install Doxygen and Graphviz
+        shell: bash
         run: sudo apt-get install -y doxygen graphviz
 
       - name: Generate Documentation
+        shell: bash
         run: doxygen Doxyfile
 
-      - name: Deploy to cockatrice.github.io
+      - name: Upload Documentation
+        uses: actions/upload-artifact@v4
+        with:
+          name: Cockatrice_Docs
+          path: ./docs/html    # Main output folder + subfolder defined in Doxygen config 
+          if-no-files-found: error
+
+      - name: Deploy to cockatrice.github.io/docs
         if: github.event_name != 'pull_request'
         uses: peaceiris/actions-gh-pages@v4
         with:
           deploy_key: ${{ secrets.DOCS_DEPLOY_KEY }}
           external_repository: Cockatrice/cockatrice.github.io
           publish_branch: master
-          publish_dir: ./docs/html
+          publish_dir: ./docs/html    # Main output folder + subfolder defined in Doxygen config 
-          destination_dir: docs   # Docs will live under https://cockatrice.github.io/docs/
+          destination_dir: docs    # Subfolder of the GitHub Pages URL where the docs live
+
+      - name: Link to Documentation Page
+        if: github.event_name != 'pull_request'
+        shell: bash
+        run: echo "::notice title=New documentation published ::Shortly available at https://cockatrice.github.io/docs/"

Doxyfile

@@ -1,4 +1,5 @@
 # Doxyfile 1.14.0
+# Docs: https://www.doxygen.nl/manual
 
 # This file describes the settings to be used by the documentation system
 # Doxygen (www.doxygen.org) for a project.
@@ -48,13 +49,13 @@ PROJECT_NAME           = "Cockatrice"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.11
+PROJECT_NUMBER         = $(COCKATRICE_REF)
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewers a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          =
+PROJECT_BRIEF          = A cross-platform virtual tabletop for multiplayer card games
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55
@@ -839,7 +840,7 @@ FILE_VERSION_FILTER    =
 # DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE
 # tag is left empty.
 
-LAYOUT_FILE            = DoxygenLayout.xml
+LAYOUT_FILE            = doc/doxygen/DoxygenLayout.xml
 
 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
 # the reference definitions. This must be a list of .bib files. The .bib
@@ -991,7 +992,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = cockatrice common doc/doxygen-groups
+INPUT                  = cockatrice common doc/doxygen/extra-pages doc/doxygen/groups .github/CONTRIBUTING.md
 
 # This tag can be used to specify the character encoding of the source files
 # that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1438,7 +1439,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        = DARK
+HTML_COLORSTYLE        = AUTO_DARK
 
 # 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
@@ -2021,7 +2022,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # If the GENERATE_LATEX tag is set to YES, Doxygen will generate LaTeX output.
 # The default value is: YES.
 
-GENERATE_LATEX         = YES
+GENERATE_LATEX         = NO
 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

doc/doxygen-extra-pages/index.md

@@ -1,8 +0,0 @@
-@mainpage Cockatrice Documentation
-
-# Welcome
-
-This is the **main landing page** of the Cockatrice documentation.
-
-- Go to the @subpage user_reference page
-- Or check out the @subpage developer_reference

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

@@ -1,4 +0,0 @@
-@page user_reference User Reference
-
-@subpage search_syntax_help
-@subpage deck_search_syntax_help

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

@@ -1,3 +1,3 @@
 @page developer_reference Developer Reference
 
-- [Contributing](@subpage contributing)
+- @subpage contributing

doc/doxygen/extra-pages/index.md

@@ -0,0 +1,12 @@
+@mainpage Cockatrice Documentation
+
+# Welcome
+
+This is the **main landing page** of the Cockatrice documentation.
+
+- Go to the @subpage user_reference page
+- Or check out the @subpage developer_reference
+
+- If you want to contribute code or translations, read our <a href="https://github.com/Cockatrice/Cockatrice?tab=contributing-ov-file#readme">CONTRIBUTING.md</a> file
+- <a href="https://github.com/Cockatrice/Cockatrice/wiki">Cockatrice Wiki</a>
+- <a href="https://cockatrice.github.io/">Cockatrice Webpage</a>

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

@@ -0,0 +1,4 @@
+@page user_reference User Reference
+
+- @subpage search_syntax_help
+- @subpage deck_search_syntax_help