Merge pull request #1 from upb-lea/docu

Docu

.github/workflows/sphinx_render_docs.yml

@@ -0,0 +1,38 @@
+name: "Sphinx: Render docs"
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+    - uses: actions/checkout@v4
+    - name: Install sphinx and build documentation with sphinx
+      run: |
+        python --version
+        pip install sphinx sphinx_rtd_theme sphinxcontrib-email
+        pip install -e .
+        cd docs
+        make html
+#    - name: Build HTML
+#      uses: ammaraskar/sphinx-action@master
+#      with:
+#        docs-folder: "docs/"
+#        pre-build-command: "pip install sphinx_rtd_theme sphinxcontrib-email"
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: html-docs
+        path: docs/build/html/
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == 'refs/heads/main'
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/build/html

pyproject.toml

@@ -5,7 +5,7 @@ authors = [
     { name = "UPB-LEA" },
 ]
 description = "Control GeckoCircuits by using python."
-readme = "README.md"
+readme = "README.rst"
 requires-python = "~=3.8"
 classifiers = [
     "Programming Language :: Python :: 3",