Update documentation (#880)

* update README example * add more text * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add load example * add mlipx and ipsuite example code * run through LLM * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * a bit more text * more example text * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update README.md * update readme * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * do not use mdformatter * fix tip * Update README.md * Update README.md * Update README.md * Update README.md * update docs * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update docs * update docstrings * update type hints * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update glossaries * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * install docs group * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add projects using zntrack * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update docs * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix spelling * typos * small docs updates * add examples * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * upload docs to pages * use gitmodule for example * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * checkout submodules for docs * add classifier example * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update docs with classifier example * update classifier example * update docs * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update docs * remove legacy examples * fix README example * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add paraffin section * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update docs comments * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix typos * fix grammar * fix grammar * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix grammar * small typo updates * show configuration files * update with comment * add example * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * remove coveralls * mention GIT and DVC repo * fix typos * format * try codecov tests * update coverage settings * add Discord * all mlflow section * node design pattern * node design patterns * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update docs * rename `ZnTrackOptionEnum` to `FieldTypes` * rename `zntrack_option` to `field_type` * rename `ZNTRACK_OPTION` to `FIELD_TYPE` * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update docs * format and update pre-commit-config * fix line length * update docs --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
zincware · Feb 14, 2025 · 72f96ca · 72f96ca
1 parent 39df826
commit 72f96ca
Show file tree

Hide file tree

Showing 83 changed files with 2,484 additions and 9,091 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -0,0 +1,58 @@
+name: Deploy Sphinx Docs to GitHub Pages
+
+on:
+  push:
+    branches: ["docs"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          submodules: "true"
+
+      - name: Install uv and set the Python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install the project dependencies
+        run: uv sync --all-extras --group=docs --dev
+
+      - name: Install pandoc
+        run: |
+          sudo apt update
+          sudo apt install -y pandoc
+
+      - name: Build Sphinx Documentation
+        run: |
+          cd docs
+          uv run make html
+
+      - name: Upload documentation artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build/html  # Path where Sphinx outputs HTML files
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: docs
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -63,66 +63,13 @@ jobs:
       - name: Pytest
         run: |
           uv run python --version
-          uv run coverage run -m pytest --benchmark-autosave -vv
-          uv run coverage xml
-          uv run coverage lcov
-          uv run py.test-benchmark compare --csv=export.csv
-      - name: Coveralls
-        uses: coverallsapp/github-action@master
+          uv run pytest --cov --junitxml=junit.xml -o junit_family=legacy
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
         with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          path-to-lcov: coverage.lcov
-      - uses: codecov/codecov-action@v2
+          token: ${{ secrets.CODECOV_TOKEN }}
+      - name: Upload test results to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/test-results-action@v1
         with:
-          flags: fulltest
-          verbose: true
-
-  # nbtest:
-  #   runs-on: ubuntu-latest
-  #   needs: [ pytest ]
-  #   steps:
-  #     - uses: actions/checkout@v2
-  #     - name: Set up Python 3.11
-  #       uses: actions/setup-python@v4
-  #       with:
-  #         python-version: "3.11"
-  #     - name: Install Poetry
-  #       uses: snok/install-poetry@v1
-  #       with:
-  #         virtualenvs-create: true
-  #         virtualenvs-in-project: true
-  #     - name: Install package
-  #       run: |
-  #         poetry install
-  #     - name: Setup git user
-  #       run: |
-  #         git config --global user.name "John Doe"
-  #         git config --global user.email [email protected]
-  #         git config --global init.defaultBranch "main"
-  #     - name: Pytest
-  #       run: |
-  #         poetry run pytest --nbmake ./examples
-
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Install uv and set the python version
-      uses: astral-sh/setup-uv@v5
-      with:
-        python-version: "3.12"
-    - name: Install the project
-      run: uv sync --all-extras --dev
-    - name: Install pandoc
-      run: |
-        sudo apt update
-        sudo apt install pandoc
-    - name: Setup git user
-      run: |
-        git config --global user.name "John Doe"
-        git config --global user.email [email protected]
-        git config --global init.defaultBranch "main"
-    - name: Build documentation
-      run: |
-        cd docs
-        uv run make html
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -168,3 +168,4 @@ dvc.yaml
 .dvc
 nodes/
 .vscode/
+junit.xml
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,9 @@
 [submodule "zntrack-examples"]
 	path = zntrack-examples
 	url = https://github.com/PythonFZ/zntrack-examples.git
+[submodule "docs/source/examples/pack_box"]
+	path = docs/source/examples/pack_box
+	url = https://github.com/PythonFZ/zntrack-examples.git
+[submodule "docs/source/examples/classifier_comparison"]
+	path = docs/source/examples/classifier_comparison
+	url = https://github.com/PythonFZ/zntrack-examples.git
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -27,12 +27,19 @@ repos:
         additional_dependencies: ["tomli"]
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: 'v0.9.6'
+    rev: v0.9.6
     hooks:
+      # Run the linter.
       - id: ruff
-        args: ['--fix']
-  - repo: https://github.com/executablebooks/mdformat
-    rev: 0.7.22
-    hooks:
-    - id: mdformat
-      args: ["--wrap=80"]
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format
+  # - repo: https://github.com/rstcheck/rstcheck
+  #   rev: 'v6.2.4'
+  #   hooks:
+  #   -   id: rstcheck
+  # - repo: https://github.com/executablebooks/mdformat
+  #   rev: 0.7.22
+  #   hooks:
+  #   - id: mdformat
+  #     args: ["--wrap=80"]
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -4,6 +4,9 @@
 
 version: 2
 
+submodules:
+  include: all
+
 # Set the version of Python and other tools you might need
 build:
   os: ubuntu-22.04
-Original file line number
+Diff line change
@@ Expand Up / @@ -168,3 +168,4 @@ dvc.yaml @@
     .dvc
     nodes/
     .vscode/
+    junit.xml