From 13af2e3ebd07d79efa9868c0230756b4c273b7c3 Mon Sep 17 00:00:00 2001 From: awschult002 <73046001+awschult002@users.noreply.github.com> Date: Mon, 18 Nov 2024 10:12:32 -0500 Subject: [PATCH 1/5] Update docs.yml to use actions for deployment hopefully this will allow actions to generate and store HTML so that we can get it out of the repo --- .github/workflows/docs.yml | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index bcb5701e4..fc25197e1 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -13,14 +13,23 @@ jobs: - name: apt-update run: sudo apt-get update -qq - name: apt-get doxygen - run: sudo apt-get install -y doxygen - - name: build doc + run: sudo apt-get install -y doxygen graphviz + - name: build docs run: make docs - - name: deploy - uses: peaceiris/actions-gh-pages@v4 + - name: Upload static files as artifact + id: deployment + uses: actions/upload-pages-artifact@v3 # or specific "vX.X.X" version tag for this action with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./doc/html/ - enable_jekyll: false - allow_empty_commit: false - force_orphan: true + path: docs/html/ + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build-documentation + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 From bdbf7f4a07d9e600ff6ac2c538aa2de0c77ec8ea Mon Sep 17 00:00:00 2001 From: "Alexander W. Schultz" Date: Mon, 18 Nov 2024 10:15:29 -0500 Subject: [PATCH 2/5] doc -> docs --- Makefile | 2 +- {doc => docs}/Doxyfile | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename {doc => docs}/Doxyfile (100%) diff --git a/Makefile b/Makefile index 5b345f7be..6f81f3389 100644 --- a/Makefile +++ b/Makefile @@ -4,7 +4,7 @@ ###################################################################################### ## path stuff -DOCS_PATH:=./doc +DOCS_PATH:=./docs DEMO_PATH=demo SRC_PATH=src diff --git a/doc/Doxyfile b/docs/Doxyfile similarity index 100% rename from doc/Doxyfile rename to docs/Doxyfile From 228b0ae97298af14037eea87dfa368768ce2dd6f Mon Sep 17 00:00:00 2001 From: "Alexander W. Schultz" Date: Mon, 18 Nov 2024 10:18:59 -0500 Subject: [PATCH 3/5] doc->docs --- docs/Doxyfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Doxyfile b/docs/Doxyfile index 003d71a87..a47c5080f 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -67,7 +67,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = ./doc +OUTPUT_DIRECTORY = ./docs # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 # sub-directories (in 2 levels) under the output directory of each output format From 1f928f7331ef56b39eed27b2ff3b60f813dbad76 Mon Sep 17 00:00:00 2001 From: awschult002 <73046001+awschult002@users.noreply.github.com> Date: Mon, 18 Nov 2024 10:27:55 -0500 Subject: [PATCH 4/5] Update docs.yml to add pages write permission --- .github/workflows/docs.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index fc25197e1..49bd6a8ca 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -29,7 +29,14 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest needs: build-documentation + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source steps: - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v4 + + + From 697f31c9acd9f02a4c7dd318ac7e32a34e75cd5a Mon Sep 17 00:00:00 2001 From: "Alexander W. Schultz" Date: Mon, 18 Nov 2024 10:34:01 -0500 Subject: [PATCH 5/5] migrate doxygen awesome into html folder for artifact upload --- Makefile | 6 +++--- docs/Doxyfile | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 6f81f3389..98cf33f82 100644 --- a/Makefile +++ b/Makefile @@ -64,14 +64,14 @@ nuke: $(addprefix $(SRC_PATH)/, $(SRC)) docs: $(DOCS_PATH)/html/index.html -$(DOCS_PATH)/html/index.html: $(DOCS_PATH)/doxygen-awesome-css/doxygen-awesome.css $(DOXYFILE) +$(DOCS_PATH)/html/index.html: $(DOCS_PATH)/html/doxygen-awesome-css/doxygen-awesome.css $(DOXYFILE) doxygen $(DOXYFILE) $(DOXYFILE): doxygen -g $@ -$(DOCS_PATH)/doxygen-awesome-css/doxygen-awesome.css: - git clone https://github.com/jothepro/doxygen-awesome-css.git $(DOCS_PATH)/doxygen-awesome-css --branch v2.3.4 +$(DOCS_PATH)/html/doxygen-awesome-css/doxygen-awesome.css: + git clone https://github.com/jothepro/doxygen-awesome-css.git $(DOCS_PATH)/html/doxygen-awesome-css --branch v2.3.4 diff --git a/docs/Doxyfile b/docs/Doxyfile index a47c5080f..004b420fd 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -1333,7 +1333,7 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = ./doc/doxygen-awesome-css/doxygen-awesome.css +HTML_EXTRA_STYLESHEET = ./docs/html/doxygen-awesome-css/doxygen-awesome.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