Add documentation ci

JeanElsner · Nov 15, 2023 · 0ec2654 · 0ec2654
1 parent 016925e
commit 0ec2654
Show file tree

Hide file tree

Showing 9 changed files with 54 additions and 1 deletion.
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -0,0 +1,52 @@
+name: Update documentation
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  id-token: write
+  pages: write
+
+jobs:
+  build:
+    name: Build documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v1
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[doc]
+      - name: Build with Sphinx
+        run: cd docs && make html
+      - name: Upload documentation artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: documentation
+          path: ./doc/_build/html
+  upload:
+    name: Upload to GitHub pages
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Download documentation artifact
+        uses: actions/download-artifact@v2
+        with:
+          name: documentation
+          path: ./html
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: ./html
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,9 +1,10 @@
-name: Test
+name: Run tests
 
 on:
   push:
     branches: ["main"]
   pull_request:
+  workflow_dispatch:
 
 jobs:
   unittest:

diff --git a/docs/Makefile → doc/Makefile b/docs/Makefile → doc/Makefile
diff --git a/docs/_static/.keep → doc/_static/.keep b/docs/_static/.keep → doc/_static/.keep
diff --git a/docs/conf.py → doc/conf.py b/docs/conf.py → doc/conf.py
diff --git a/docs/dm_robotics.panda.rst → doc/dm_robotics.panda.rst b/docs/dm_robotics.panda.rst → doc/dm_robotics.panda.rst
diff --git a/docs/index.rst → doc/index.rst b/docs/index.rst → doc/index.rst
diff --git a/docs/make.bat → doc/make.bat b/docs/make.bat → doc/make.bat
diff --git a/docs/tutorial.rst → doc/tutorial.rst b/docs/tutorial.rst → doc/tutorial.rst