✨ Modernise repository (#16)

- ruff linting/formatting
- poetry -> flit + tox-uv
- Fix sphinx deprecation warnings (update CSS/JS instillation)
- Add logger warnings for non-html builders
- Add tests
- Add GH action CI
- Use furo docs theme (remove all the ubdocs stuff)
- update version to 0.2.0 (ready for release)

.github/dependabot.yml

@@ -0,0 +1,19 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    commit-message:
+      prefix: 🔧
+    schedule:
+      interval: monthly
+  - package-ecosystem: pip
+    directory: /
+    commit-message:
+      prefix: ⬆️
+    schedule:
+      interval: monthly

.github/workflows/ci.yaml

@@ -0,0 +1,66 @@
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+jobs:
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.8'
+    - uses: pre-commit/[email protected]
+
+  tests:
+    name: "Core py${{ matrix.python-version }} sphinx~=${{ matrix.sphinx-version }} ${{ matrix.os }}"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false  # Set on "false" to get the results of ALL builds
+      matrix:
+        os: ["ubuntu-latest"]
+        # 3.9.8 seems to be broken with type_ast
+        # https://www.mail-archive.com/[email protected]/msg1829077.html
+        python-version: ["3.8", "3.11"]
+        sphinx-version: ["6.0", "7.0", "8.0"]
+        include:
+          - os: "windows-latest"
+            python-version: "3.8"
+            sphinx-version: "6.0"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set Up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Update pip
+        run: python -m pip install --upgrade pip
+      - name: Install dependencies
+        run: |
+          python -m pip install sphinx~=${{ matrix.sphinx-version }} -e .[test]
+          python -m pip freeze
+      - name: Run pytest
+        run: python -m pytest -v --cov=src --cov-report=xml --cov-report=term-missing tests
+
+  check:
+
+    # This job does nothing and is only used for the branch protection
+    # see https://github.com/marketplace/actions/alls-green#why
+
+    if: always()
+
+    needs:
+    - lint
+    - tests
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Decide whether the needed jobs succeeded or failed
+      uses: re-actors/alls-green@release/v1
+      with:
+        jobs: ${{ toJSON(needs) }}

.gitignore

@@ -16,7 +16,7 @@ _build
 .doctrees
 docs/github_images/
 .eggs/
-docs/_images/need_pie_*.png
+.ruff_cache
 
 .devcontainer/
 .vscode/

.pre-commit-config.yaml

@@ -1,22 +1,7 @@
 repos:
-  - repo: https://github.com/psf/black
-    rev: 24.1.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.1
     hooks:
-      - id: black
-
-  - repo: https://github.com/PyCQA/flake8
-    rev: 6.1.0
-    hooks:
-      - id: flake8
-        additional_dependencies:
-          - flake8-bugbear
-          - flake8-comprehensions
-          - flake8-simplify
-          - pep8-naming
-
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.0
-    hooks:
-      - id: pyupgrade
-        args:
-          - --py36-plus
+    - id: ruff
+      args: [--fix]
+    - id: ruff-format

.readthedocs.yml

@@ -7,10 +7,11 @@ build:
 
 sphinx:
   configuration: docs/conf.py
+  builder: html
+  fail_on_warning: true
 
 python:
   install:
-    - requirements: docs/requirements.txt
     - method: pip
       path: .
       extra_requirements:

docs/_static/custom.css

@@ -1,18 +1,12 @@
 /* Data viewer */
 .json-container .json-key {
-    color: var(--md-code-fg-color);
+    color: var(--color-foreground-primary);
 }
 
 .json-container .json-size {
-    color: var(--md-code-hl-number-color);
+    color: var(--color-foreground-muted);
 }
 
-.sd-card {
-    border: 1px solid var(--md-typeset-color);
+table.need {
+    background-color: transparent;
 }
-.border {
-    border: 1px solid var(--md-typeset-color);
-}
-.sd-card-header {
-    border-bottom: 1px solid var(--md-typeset-color);
-}