From a4057582226fee3dabb53fe2ab511473f6c7342c Mon Sep 17 00:00:00 2001 From: tooomm Date: Sun, 16 Nov 2025 23:51:27 +0100 Subject: [PATCH] doxygen config changes (#6330) --- .github/workflows/documentation-build.yml | 3 +++ Doxyfile | 11 ++++++----- DoxygenLayout.xml => doc/doxygen/DoxygenLayout.xml | 0 3 files changed, 9 insertions(+), 5 deletions(-) rename DoxygenLayout.xml => doc/doxygen/DoxygenLayout.xml (100%) diff --git a/.github/workflows/documentation-build.yml b/.github/workflows/documentation-build.yml index 933f43d28..ef0f0af91 100644 --- a/.github/workflows/documentation-build.yml +++ b/.github/workflows/documentation-build.yml @@ -11,6 +11,9 @@ on: - '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 diff --git a/Doxyfile b/Doxyfile index a1861f64f..6a09e2619 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,4 +1,5 @@ # Doxyfile 1.14.0 +# Doxygen 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 @@ -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 diff --git a/DoxygenLayout.xml b/doc/doxygen/DoxygenLayout.xml similarity index 100% rename from DoxygenLayout.xml rename to doc/doxygen/DoxygenLayout.xml