Merge pull request #8 from predict-idlab/integrate_obelisk_core

Implement Obelisk Core

Author: Epse

.github/workflows/ci.yml

@@ -31,5 +31,6 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
-      - uses: astral-sh/setup-uv@v3
+      - uses: astral-sh/setup-uv@v6
+      - run: uv python install
       - run: uv run pytest

.gitignore

@@ -48,6 +48,7 @@ cover/
 # Sphinx documentation
 docs/_build/
 docs/build/
+docs/source/_autosummary/
 
 # PyBuilder
 .pybuilder/
@@ -74,6 +75,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+pyrightconfig.json
 
 # Spyder project settings
 .spyderproject

README.md

@@ -65,6 +65,10 @@ Building is as follows:
 # uv run sphinx-build -M html docs/source/ docs/build/
 ```
 
+In case of major restructuring, it may be needed to clean up the contents of `docs/_autosummary` and potentially other rst files in `docs`,
+followed by re-running the build.
+Manually triggering sphinx-apidoc is unnecessary.
+
 ## Credits
 
 Base implementation originally by Pieter Moens <[email protected]>,