From 518c70dfbbd538213e1959d64e02357d60163277 Mon Sep 17 00:00:00 2001 From: Abdoulbari ZAKIR Date: Wed, 15 Nov 2023 15:21:50 +0100 Subject: [PATCH 1/3] dark mode --- .github/workflows/doxygen.yml | 8 +++-- docs/Doxyfile | 34 +++++++++++------- docs/antares-simulator-doxygen.patch | 52 ++++++++++++++++++++++++++++ 3 files changed, 78 insertions(+), 16 deletions(-) create mode 100644 docs/antares-simulator-doxygen.patch diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 9b91102fa0..ec3bf7868b 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -3,7 +3,7 @@ name: GitHub Pages on: push: branches: - - develop # Set a branch name to trigger deployment + - docs/dark-mode-switch # Set a branch name to trigger deployment jobs: deploy: @@ -23,6 +23,7 @@ jobs: git clone https://github.com/jothepro/doxygen-awesome-css.git cd doxygen-awesome-css git checkout v2.2.1 + git apply ../docs/antares-simulator-doxygen.patch - name: Doxygen uses: mattnotmitt/doxygen-action@1.9.5 @@ -34,10 +35,11 @@ jobs: # If you're changing the branch from main, # also change the `main` in `refs/heads/main` # below accordingly. - if: github.ref == 'refs/heads/develop' + # /!\ tmp + if: github.ref == 'refs/heads/docs/dark-mode-switch' with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./html - \ No newline at end of file + diff --git a/docs/Doxyfile b/docs/Doxyfile index 24c257cd98..ba758079b7 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -54,7 +54,7 @@ PROJECT_NUMBER = # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = +PROJECT_BRIEF = Power System Simulator # 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 @@ -943,7 +943,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = src/ +INPUT = README.md src/ # 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 @@ -1158,7 +1158,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = README.md # The Fortran standard specifies that for fixed formatted Fortran code all # characters from position 72 are to be considered as comment. A common @@ -1357,7 +1357,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = +HTML_HEADER = doxygen-awesome-css/doxygen-custom/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1398,7 +1398,10 @@ HTML_STYLESHEET = # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \ - doxygen-awesome-css/doxygen-awesome-sidebar-only.css + doxygen-awesome-css/doxygen-custom/custom.css \ + doxygen-awesome-css/doxygen-awesome-sidebar-only.css \ + doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css \ + doxygen-awesome-css/doxygen-custom/custom-alternative.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1408,7 +1411,12 @@ HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \ # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = +HTML_EXTRA_FILES = doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \ + doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \ + doxygen-awesome-css/doxygen-awesome-paragraph-link.js \ + doxygen-awesome-css/doxygen-custom/toggle-alternative-theme.js \ + doxygen-awesome-css/doxygen-awesome-interactive-toc.js \ + doxygen-awesome-css/doxygen-awesome-tabs.js # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. @@ -1432,7 +1440,7 @@ HTML_COLORSTYLE = LIGHT # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_COLORSTYLE_HUE = 220 +HTML_COLORSTYLE_HUE = 209 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use gray-scales only. A @@ -1440,7 +1448,7 @@ HTML_COLORSTYLE_HUE = 220 # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_SAT = 255 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 @@ -1451,7 +1459,7 @@ HTML_COLORSTYLE_SAT = 100 # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_COLORSTYLE_GAMMA = 80 +HTML_COLORSTYLE_GAMMA = 113 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that @@ -1758,7 +1766,7 @@ ENUM_VALUES_PER_LINE = 4 # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. -TREEVIEW_WIDTH = 250 +TREEVIEW_WIDTH = 335 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. @@ -1809,7 +1817,7 @@ FORMULA_MACROFILE = # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -USE_MATHJAX = NO +USE_MATHJAX = YES # With MATHJAX_VERSION it is possible to specify the MathJax version to be used. # Note that the different versions of MathJax have different requirements with @@ -1851,7 +1859,7 @@ MATHJAX_FORMAT = HTML-CSS # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 # This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_RELPATH = +MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example @@ -1969,7 +1977,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/docs/antares-simulator-doxygen.patch b/docs/antares-simulator-doxygen.patch new file mode 100644 index 0000000000..4ada1e677d --- /dev/null +++ b/docs/antares-simulator-doxygen.patch @@ -0,0 +1,52 @@ +From 7219365be1db9b4bd55ffa6a2cea5b56c5029e7e Mon Sep 17 00:00:00 2001 +From: Abdoulbari ZAKIR +Date: Wed, 15 Nov 2023 14:35:52 +0100 +Subject: [PATCH] patch for xpansion + +Signed-off-by: Abdoulbari ZAKIR +--- + doxygen-custom/header.html | 18 +++++++++--------- + 1 file changed, 9 insertions(+), 9 deletions(-) + +diff --git a/doxygen-custom/header.html b/doxygen-custom/header.html +index 7f37e6f..35ab907 100644 +--- a/doxygen-custom/header.html ++++ b/doxygen-custom/header.html +@@ -7,16 +7,16 @@ + + + +- +- +- +- ++ ++ ++ ++ + + + +- +- +- ++ ++ ++ + + + $projectname: $title +@@ -46,8 +46,8 @@ $extrastylesheet + + + +- +- ++ ++ + + +-- +2.37.3.windows.1 + From 1904199e027d2df5592f68ebdc6b18be7c433b72 Mon Sep 17 00:00:00 2001 From: Abdoulbari ZAKIR Date: Wed, 15 Nov 2023 15:26:32 +0100 Subject: [PATCH 2/3] update the patch --- docs/antares-simulator-doxygen.patch | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/antares-simulator-doxygen.patch b/docs/antares-simulator-doxygen.patch index 4ada1e677d..6615153b33 100644 --- a/docs/antares-simulator-doxygen.patch +++ b/docs/antares-simulator-doxygen.patch @@ -20,10 +20,10 @@ index 7f37e6f..35ab907 100644 - - - -+ -+ -+ -+ ++ ++ ++ ++ @@ -31,8 +31,8 @@ index 7f37e6f..35ab907 100644 - - + -+ -+ ++ ++ $projectname: $title From 14c816cb894eb3ed3a0e9dc164b91de4e5c04b6e Mon Sep 17 00:00:00 2001 From: Abdoulbari ZAKIR Date: Wed, 15 Nov 2023 15:41:36 +0100 Subject: [PATCH 3/3] update antares links --- docs/antares-simulator-doxygen.patch | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/antares-simulator-doxygen.patch b/docs/antares-simulator-doxygen.patch index 6615153b33..01a24657d1 100644 --- a/docs/antares-simulator-doxygen.patch +++ b/docs/antares-simulator-doxygen.patch @@ -30,7 +30,7 @@ index 7f37e6f..35ab907 100644 - - - -+ ++ + + @@ -42,8 +42,8 @@ index 7f37e6f..35ab907 100644 - - -+ -+ ++ ++