🔧 Rename error directive to fault

.github/workflows/ci.yaml

@@ -0,0 +1,17 @@
+name: CI
+on:
+  pull_request:
+jobs:
+  docs:
+    name: docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version-file: ".python-version"
+      - name: Build docs
+        run: uv run sphinx-build -b html . _build/html

.github/workflows/gh_pages.yml

@@ -27,18 +27,15 @@ jobs:
     name: Build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Setup Pages
-        id: pages
-        uses: actions/configure-pages@v5
-      - name: Install graphviz
-        run: sudo apt-get --yes install graphviz
-      - uses: eifinger/setup-rye@v4
-      - run: rye sync
-      # TODO locally rye sync appears to correctly run maturin internally,
-      # but on the CI intermitently fails to build the extension
-      - name: Run documentation build
-        run: rye run sphinx-build -a -E -b html . _build/html 
+      - uses: actions/checkout@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version-file: ".python-version"
+      - name: Build docs
+        run: uv run sphinx-build -b html . _build/html
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

.gitignore

@@ -8,7 +8,6 @@ wheels/
 
 # venv
 .venv
-.python-version
 _build
 .report.json
 .vscode

.python-version

@@ -0,0 +1 @@
+3.12.7

README.md

@@ -19,9 +19,9 @@ the MIT License.
 ## Installation
 
 1. Check out repo
-2. Use `rye` for manageing the Python venv
-3. Install Python dependencies: `rye sync`
-4. Build docs via: `rye run sphinx-build -a -E -b html . _build/html`
+2. Use `uv` for manageing the Python venv
+3. Install Python dependencies: `uv sync`
+4. Build docs via: `uv run sphinx-build -a -E -b html . _build/html`
 5. Open any browser, for instance via `firefox _build/html/index.html`
 
 ## Usage

analysis/index.rst

@@ -39,11 +39,11 @@ By Tool
 By Type
 ~~~~~~~
 .. needpie::
-   :labels: Use Case, Feature, Error, Restriction, Artifact
+   :labels: Use Case, Feature, Fault, Restriction, Artifact
 
    type == "usecase"
    type == "feature"
-   type == "error"
+   type == "fault"
    type == "restriction"
    type == "artifact"
 

analysis/qualification.rst

@@ -46,7 +46,7 @@ Overall Features: :need_count:`type=="feature"`
 
 Errors
 ------
-Overall Errors: :need_count:`type=="error"`
+Overall Errors: :need_count:`type=="fault"`
 
 .. list-table::
    :align: center
@@ -58,14 +58,14 @@ Overall Errors: :need_count:`type=="error"`
      * Measurement
      * Target
    - * Errors without Mitigation
-     * :need_count:`type == "error" and len(avoids_back) == 0`
+     * :need_count:`type == "fault" and len(avoids_back) == 0`
      * 0
 
 .. dropdown:: Errors without Mitigation
 
    .. needtable::
       :columns: id, title, parent_needs
-      :filter: type == "error" and len(avoids_back) == 0
+      :filter: type == "fault" and len(avoids_back) == 0
 
 Restrictions
 ------------

pyproject.toml

@@ -7,7 +7,7 @@ authors = [
 ]
 dependencies = [
     "sphinx[test]>=8.2.3",
-    "sphinx-needs[plotting]>=5.1.0",
+    "sphinx-needs[plotting]>=6.1.0",
     "sphinxcontrib-plantuml>=0.30",
     "sphinx-design>=0.6.1",
     "sphinx-simplepdf>=1.6.0",
@@ -20,10 +20,6 @@ requires-python = ">= 3.11"
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
-[tool.rye]
-managed = true
-dev-dependencies = []
-
 [tool.hatch.metadata]
 allow-direct-references = true