From 5ca892610e370f62001a30dc636838b3af13ae06 Mon Sep 17 00:00:00 2001 From: gab-k Date: Wed, 27 Nov 2024 22:44:08 +0100 Subject: [PATCH] update workflow --- .github/workflows/docs.yml | 29 +++++------------------------ docs/requirements.txt | 1 - docs/sphinx/source/requirements.txt | 3 +++ 3 files changed, 8 insertions(+), 25 deletions(-) delete mode 100644 docs/requirements.txt create mode 100644 docs/sphinx/source/requirements.txt diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e34b6e0..77ab20b 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -8,7 +8,7 @@ on: jobs: - doxy-build: + build: runs-on: ubuntu-latest steps: - name: Check out the repo @@ -20,40 +20,21 @@ jobs: # Path to Doxyfile doxyfile-path: 'docs/doxygen/Doxyfile' - - name: Upload doxygen files as artifact - uses: actions/upload-artifact@v4 - with: - name: doxygen_files - path: build/xml/ - - sphinx-build: - runs-on: ubuntu-latest - needs: doxy-build - steps: - - name: Check out the repo - uses: actions/checkout@v4 - - - name: Download doxygen files artifact - uses: actions/download-artifact@v4 - with: - name: doxygen_files - path: build/xml/ - - name: Sphinx build uses: ammaraskar/sphinx-action@0.4 with: - docs-folder: "docs/sphinx" + docs-folder: "docs/sphinx/source" - name: Upload sphinx files as artifact uses: actions/upload-artifact@v4 with: name: sphinx_files - path: build/ + path: docs/sphinx/build/ deploy-main: if: github.ref == 'refs/heads/main' # Only deploy on 'main' branch runs-on: ubuntu-latest - needs: sphinx-build + needs: build steps: - name: Download sphinx files artifact @@ -73,7 +54,7 @@ jobs: deploy-dev: if: github.ref == 'refs/heads/dev' # Only deploy on 'dev' branch runs-on: ubuntu-latest - needs: sphinx-build + needs: build steps: - name: Download doxygen files artifact diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 3ffe4e3..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -sphinx-rtd-theme==3.0.2 \ No newline at end of file diff --git a/docs/sphinx/source/requirements.txt b/docs/sphinx/source/requirements.txt new file mode 100644 index 0000000..57dc32e --- /dev/null +++ b/docs/sphinx/source/requirements.txt @@ -0,0 +1,3 @@ +sphinx-rtd-theme==3.0.2 +breathe==4.35.0 +myst-parser==4.0.0 \ No newline at end of file