diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 9cb2301..3e1df41 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -18,36 +18,3 @@ jobs: - run: cmake -S . -B build -DCMAKE_BUILD_TYPE=Release - run: cmake --build build --parallel - run: ctest --test-dir build --output-on-failure --verbose --no-compress-output - - docs: - name: Generate and Deploy Docs - runs-on: ubuntu-latest - permissions: - contents: read - pages: write - id-token: write - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - steps: - - uses: actions/checkout@v4 - - - name: Install Doxygen - run: sudo apt-get update && sudo apt-get install -y doxygen - - # Runs on every push and PR to verify Doxygen doesn't crash - - name: Generate Documentation - run: doxygen Doxyfile - - # Only upload the artifact if merging into main - - name: Upload GitHub Pages Artifact - if: github.ref == 'refs/heads/main' - uses: actions/upload-pages-artifact@v3 - with: - path: './docs/html' - - # Only deploy the site if merging into main - - name: Deploy to GitHub Pages - if: github.ref == 'refs/heads/main' - id: deployment - uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..e17aee7 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,17 @@ +# .readthedocs.yaml +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.12" + apt_packages: + - doxygen + jobs: + build: + # Run Doxygen just like you did locally + - doxygen Doxyfile + # Create the required Read the Docs output directory + - mkdir -p $READTHEDOCS_OUTPUT/html/ + # Copy the generated HTML into the output directory + - cp -r docs/html/* $READTHEDOCS_OUTPUT/html/ \ No newline at end of file