Merge pull request #22 from MatInGit/20-documentation

Improved docs

Author: MatInGit

.github/workflows/docs.yml

@@ -0,0 +1,57 @@
+name: Build & Deploy Sphinx Docs
+
+on:
+  push:
+    branches: [20-documentation]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📥 Checkout code
+        uses: actions/checkout@v3
+
+      - name: 🐍 Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: 📦 Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install sphinx furo sphinx-autodoc-typehints
+
+    #   - name: 🛠️ Build documentation #  we are just using the uploaded ones
+    #     run: |
+    #       cd docs
+    #       make html
+
+      - name: 📂 Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build/html/
+
+  deploy:
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action

.gitignore

@@ -22,7 +22,7 @@ test.ipynb
 image_model
 test.h5
 .vscode
-build
+/build
 env.json
 creds.json
 test.py

docs/Makefile

@@ -0,0 +1,30 @@
+# Minimal makefile for Sphinx documentation
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Adjust this to point to your Python package directory (relative to this Makefile)
+APIDOCSRC     = ../poly_lithic
+APIDOCOUT     = $(SOURCEDIR)/api
+
+.PHONY: help Makefile apidoc
+
+# Default target: "make" is like "make help"
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+# Autogenerate .rst files from Python source using sphinx-apidoc
+apidoc:
+	sphinx-apidoc -o $(APIDOCOUT) $(APIDOCSRC) --force --no-toc --separate
+
+# Build HTML docs, running apidoc first
+html: apidoc
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+# Catch-all target: route all unknown targets to Sphinx
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)