chore: merge pull request #36 from threeal/use-github-page

Deploy Documentation to GitHub Pages

.github/workflows/build.yml

@@ -99,17 +99,16 @@ jobs:
  docs:
  runs-on: ubuntu-latest
  steps:
- - name: Checkout repository
+ - name: Checkout
  uses: actions/[email protected]
 
- - name: Install dependencies
+ - name: Install requirements
  run: pip3 install -r docs/requirements.txt
 
- - name: Build documentation
+ - name: Build with Sphinx
  run: sphinx-build -b html docs build/docs -W --keep-going
 
- - name: Upload documentation as artifact
- uses: actions/upload-artifact@v3.1.2
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v1.0.8
  with:
- name: docs
  path: build/docs

.github/workflows/deploy.yaml

@@ -0,0 +1,39 @@
+name: deploy
+on:
+ workflow_dispatch:
+ push:
+ branches: [main]
+permissions:
+ contents: read
+ pages: write
+ id-token: write
+concurrency:
+ group: pages
+ cancel-in-progress: false
+jobs:
+ docs:
+ runs-on: ubuntu-latest
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ steps:
+ - name: Checkout
+ uses: actions/[email protected]
+
+ - name: Install requirements
+ run: pip3 install -r docs/requirements.txt
+
+ - name: Setup Pages
+ uses: actions/[email protected]
+
+ - name: Build with Sphinx
+ run: sphinx-build -b html docs docs/build -W --keep-going
+
+ - name: Upload artifact
+ uses: actions/[email protected]
+ with:
+ path: docs/build
+
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/[email protected]

.gitignore

@@ -2,6 +2,5 @@
 !.clang*
 !.cmake*
 !.git*
-!.readthedocs*
 
 build