feat: upgraded versions, added coverage and sphinx support

Author: sehoffmann

.github/actions/setup_environment/action.yml

@@ -1,14 +1,14 @@
 name: Setup CI Environment
 inputs:
   python-version:
-    default: "3.9"
+    default: "3.11"
     type: string
 
 runs:
   using: composite
   steps:
     - name: Setup Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ inputs.python-version }}
 

.github/workflows/build_and_upload_wheel.yml

@@ -23,20 +23,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-      uses: actions/checkout@v3
-      with:
-        ref: ${{ inputs.branch }}
-        submodules: recursive
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.branch }}
+          submodules: recursive
 
       - name: Setup Environment
         uses: ./.github/actions/setup_environment
 
       - name: Build Wheel
         run: |
-          python3 -m build
+          python -m build
 
       - name: Upload Wheels to Github
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: wheels
           path: dist/*.whl
@@ -48,9 +48,14 @@ jobs:
     outputs:
       upload: ${{ steps.trigger_upload.outputs.value }}
     steps:
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
       - name: Download Artifacts From Github
         continue-on-error: true
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: wheels
 
@@ -74,7 +79,7 @@ jobs:
         env:
           PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
         run: |
-          pip3 install twine
+          pip install twine
           if [[ "${{ inputs.real-pypi }}" == true ]]; then
             python -m twine upload \
               --username __token__ \

.github/workflows/run_linting.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 

.github/workflows/run_tests.yml

@@ -17,12 +17,10 @@ jobs:
           - ubuntu-latest
           - windows-latest
         python-version:
-          #- "3.8"
-          - "3.9"
-          #- "3.10"
+          - "3.11"
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -33,12 +31,21 @@ jobs:
 
       - name: Install Dependencies
         run: |
-          pip3 install -r requirements.txt
+          pip install -r requirements.txt
 
       - name: Install Project
         run: |
-          pip3 install .
+          pip install .
 
-      - name: Run Tests
-        run:
-          pytest --no-header -v test
+      - name: Run tests & coverage
+        run: |
+          coverage run -m pytest --no-header -v test
+          coverage report -m -i
+          coverage html -i
+
+      - name: Archive coverage results
+        if: startsWith(matrix.os, 'ubuntu')
+        uses: actions/upload-artifact@v4
+        with:
+          name: code-coverage-report
+          path: htmlcov

.gitignore

@@ -1,3 +1,6 @@
+# Sphinx Build
+/doc/_build
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

build_documentation.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+cd doc
+make html

ci_requirements.txt

@@ -1,2 +1,8 @@
+setuptools
+packaging
+wheel
+build
 pre-commit
 pytest
+sphinx
+coverage

doc/Makefile

@@ -0,0 +1,20 @@
+# 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     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/conf.py

@@ -0,0 +1,27 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'python-quickstart'
+copyright = '2025, Author Name(s)'
+author = 'Author Name(s)'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

doc/index.rst

@@ -0,0 +1,17 @@
+.. python-quickstart documentation master file, created by
+   sphinx-quickstart on Fri Jan 17 13:18:00 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+python-quickstart documentation
+===============================
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+