From 68bdfd9a91161e6432e2f82730f32c5b323776bf Mon Sep 17 00:00:00 2001 From: botamochi6277 Date: Mon, 15 Apr 2024 00:13:30 +0900 Subject: [PATCH 1/6] Import readme.md as doxygen mainpage --- Doxyfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doxyfile b/Doxyfile index a396f2f..3c690a5 100644 --- a/Doxyfile +++ b/Doxyfile @@ -874,7 +874,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = +INPUT = README.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 @@ -1034,7 +1034,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 #--------------------------------------------------------------------------- # Configuration options related to source browsing From 95ee668d7893975b26143fba7f8c8a0acb1f2f31 Mon Sep 17 00:00:00 2001 From: botamochi6277 Date: Mon, 15 Apr 2024 18:45:17 +0900 Subject: [PATCH 2/6] Modify input for doxygen --- Doxyfile | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Doxyfile b/Doxyfile index 3c690a5..28c520a 100644 --- a/Doxyfile +++ b/Doxyfile @@ -874,7 +874,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = README.md +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 @@ -2278,7 +2278,7 @@ HIDE_UNDOC_RELATIONS = YES # set to NO # The default value is: NO. -HAVE_DOT = NO +HAVE_DOT = YES # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed # to run in parallel. When set to 0 doxygen will base this on the number of @@ -2347,7 +2347,7 @@ GROUP_GRAPHS = YES # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. -UML_LOOK = NO +UML_LOOK = YES # If the UML_LOOK tag is enabled, the fields and methods are shown inside the # class node. If there are many fields or methods and many nodes the graph may @@ -2470,7 +2470,7 @@ DIR_GRAPH_MAX_DEPTH = 1 # The default value is: png. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_IMAGE_FORMAT = png +DOT_IMAGE_FORMAT = svg # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to # enable generation of interactive SVG images that allow zooming and panning. @@ -2482,7 +2482,7 @@ DOT_IMAGE_FORMAT = png # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. -INTERACTIVE_SVG = NO +INTERACTIVE_SVG = YES # The DOT_PATH tag can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. From cc783a539b010a4224d9944d02ab87f6467339e6 Mon Sep 17 00:00:00 2001 From: botamochi6277 Date: Wed, 17 Apr 2024 20:28:13 +0900 Subject: [PATCH 3/6] Suppress doxygen job at pull requests --- .github/workflows/doxygen.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index c013b86..c1f6819 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -1,9 +1,10 @@ name: A job to build doxgen document and deploy it on github-pages on: push: - branches: [main, master, doxygen] - pull_request: - branches: [main, master] + branches: + - main + - master + - 'doxygen*' workflow_dispatch: jobs: From ef808584f546fb402f6b5849f94600882d163ba3 Mon Sep 17 00:00:00 2001 From: botamochi6277 Date: Wed, 17 Apr 2024 20:33:13 +0900 Subject: [PATCH 4/6] Add copy task after doxygen build --- .github/workflows/doxygen.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index c1f6819..24fdfec 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -16,6 +16,8 @@ jobs: run: | curl -OL https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/main/doxygen-awesome.css - uses: mattnotmitt/doxygen-action@v1.9.5 + - name: copy image + run: cp -r docs html - name: Deploy pages uses: peaceiris/actions-gh-pages@v3 with: From 07570702e81ebbef79c06e6a9124487d2c6bbdf4 Mon Sep 17 00:00:00 2001 From: botamochi6277 Date: Wed, 17 Apr 2024 20:38:56 +0900 Subject: [PATCH 5/6] Copy file with actions --- .github/workflows/doxygen.yml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 24fdfec..a652f92 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -16,8 +16,11 @@ jobs: run: | curl -OL https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/main/doxygen-awesome.css - uses: mattnotmitt/doxygen-action@v1.9.5 - - name: copy image - run: cp -r docs html + - name: copy file + uses: canastro/copy-file-action@master + with: + source: "docs" + target: "html" - name: Deploy pages uses: peaceiris/actions-gh-pages@v3 with: From 32adfbcb1c3f0d45ef494e08886d9a3279f64907 Mon Sep 17 00:00:00 2001 From: botamochi6277 Date: Wed, 17 Apr 2024 20:40:28 +0900 Subject: [PATCH 6/6] Suppress copy in action --- .github/workflows/doxygen.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index a652f92..c1f6819 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -16,11 +16,6 @@ jobs: run: | curl -OL https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/main/doxygen-awesome.css - uses: mattnotmitt/doxygen-action@v1.9.5 - - name: copy file - uses: canastro/copy-file-action@master - with: - source: "docs" - target: "html" - name: Deploy pages uses: peaceiris/actions-gh-pages@v3 with: