feat(workflows): deploy documentation

Signed-off-by: Charles Madjeri <[email protected]>
ASM-Studios · Nov 26, 2024 · 4aa9dec · 4aa9dec
1 parent c006d9c
commit 4aa9dec
Show file tree

Hide file tree

Showing 16 changed files with 31 additions and 1 deletion.
diff --git a/.github/workflows/deploy-documentation.yml b/.github/workflows/deploy-documentation.yml
@@ -0,0 +1,27 @@
+name: deploy-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 docs/source _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
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 # IDE
 .idea/
+.vscode/
 
 # Documentation
 build/

diff --git a/README.md b/README.md
@@ -73,7 +73,9 @@ sphinx and sphinx_rtd_theme can be installed using pip
 
 #### Usage
 
-The documentation is available at [AREA Documentation](). // TODO: Add link
+The documentation is automatically built and deployed to GitHub Pages when a push is made to the `main` branch.
+
+You can consult the documentation online at [AREA Documentation](https://asm-studios.github.io/AREA/).
 
 You can build the documentation locally by running the following command:
 ```sh

diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
diff --git a/doc/source/Project/benchmark.rst → docs/source/Project/benchmark.rst b/doc/source/Project/benchmark.rst → docs/source/Project/benchmark.rst
diff --git a/doc/source/Project/index.rst → docs/source/Project/index.rst b/doc/source/Project/index.rst → docs/source/Project/index.rst
diff --git a/doc/source/client_mobile/index.rst → docs/source/client_mobile/index.rst b/doc/source/client_mobile/index.rst → docs/source/client_mobile/index.rst
diff --git a/doc/source/client_mobile/installation.rst → docs/source/client_mobile/installation.rst b/doc/source/client_mobile/installation.rst → docs/source/client_mobile/installation.rst
diff --git a/doc/source/client_web/context.rst → docs/source/client_web/context.rst b/doc/source/client_web/context.rst → docs/source/client_web/context.rst
diff --git a/doc/source/client_web/index.rst → docs/source/client_web/index.rst b/doc/source/client_web/index.rst → docs/source/client_web/index.rst
diff --git a/doc/source/client_web/installation.rst → docs/source/client_web/installation.rst b/doc/source/client_web/installation.rst → docs/source/client_web/installation.rst
diff --git a/doc/source/conf.py → docs/source/conf.py b/doc/source/conf.py → docs/source/conf.py
diff --git a/doc/source/contributing.rst → docs/source/contributing.rst b/doc/source/contributing.rst → docs/source/contributing.rst
diff --git a/doc/source/index.rst → docs/source/index.rst b/doc/source/index.rst → docs/source/index.rst
diff --git a/doc/source/server/index.rst → docs/source/server/index.rst b/doc/source/server/index.rst → docs/source/server/index.rst
diff --git a/doc/source/server/installation.rst → docs/source/server/installation.rst b/doc/source/server/installation.rst → docs/source/server/installation.rst