testing docs deploy
authorClaromes <claromes@hey.com>
Fri, 14 Jun 2024 09:37:29 +0000 (06:37 -0300)
committerClaromes <claromes@hey.com>
Fri, 14 Jun 2024 09:37:29 +0000 (06:37 -0300)
.github/documentation.yml [new file with mode: 0644]

diff --git a/.github/documentation.yml b/.github/documentation.yml
new file mode 100644 (file)
index 0000000..54f003c
--- /dev/null
@@ -0,0 +1,27 @@
+name: documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme myst_parser
+      - name: Sphinx build
+        run: |
+          sphinx-build doc _build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true