OPEN - Documentation Deployment with Sphinx

.github/workflows/documentation.yml

@@ -0,0 +1,27 @@
+name: documentation
+
+on: [push, pull_request]
+
+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 numpy mako onnx_graphsurgeon ortools sphinx sphinx_rtd_theme myst_parser
+      - name: Sphinx build
+        run: |
+          sphinx-build docs _build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Unreleased
 
+
+## Deploy Documentation with Sphinx and GitHub Pages
+
+### Added
+- Add the `documentation.yml` workflow to deploy doc pages.
+
+### Changed
+- Updated `README.md` with direct link to the documentation page.
+
+
 ## Fix Generic Softmax Kernel
 
 ### Fixed

README.md

@@ -65,11 +65,13 @@ Now you can open the generated code in `DeeployTest/TEST_SIRACUSA/Tests/testMatM
 
 ## Documentation
 
-To build the documentation, simply run:
+All relevant documentation can be found in the `docs` folder and is hosted on [GitHub Pages](https://pulp-platform.github.io/Deeploy/).
+
+To build the documentation locally, simply run:
 ```
 make docs
 ```
-Then open `docs/_build/html/index.html` for more extensive documentation & getting-started guides.
+Then open `docs/_build/html/index.html` .
 
 ## Publications