Merge pull request #65 from DanielDauner/dev_v0.0.7

Merge `dev_0.0.7` into main

Author: DanielDauner

.github/workflows/deploy-docs.yaml

@@ -0,0 +1,54 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - main # Change this to your branch name (e.g., docs, dev, etc.)
+  workflow_dispatch:  # Allows manual triggering
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          pip install uv
+          uv pip install --system -e ".[docs]"
+
+      - name: Build Sphinx documentation
+        run: |
+            sphinx-build docs docs/_build -b dirhtml
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: 'docs/_build'
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{steps.deployment.outputs.page_url}}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+        with:
+          publish_dir: './docs/_build'

.gitignore

@@ -23,10 +23,12 @@
 *.csv
 *.log
 *.mp4
-
+exp/
 
 # Sphinx documentation
 docs/_build/
 docs/build/
 _build/
 .doctrees/
+
+jbwang_*

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ repos:
     rev: v5.0.0
     hooks:
       - id: check-added-large-files # prevents giant files from being committed.
-        args: ['--maxkb=1024']
+        args: ['--maxkb=5120']
       - id: check-case-conflict # checks for files that would conflict in case-insensitive filesystems.
       - id: check-merge-conflict # checks for files that contain merge conflict strings.
       - id: check-yaml # checks yaml files for parseable syntax.
@@ -24,6 +24,7 @@ repos:
       - id: isort
         name: isort (python)
         args: ["--profile", "black", "--filter-files", '--line-length', '120']
+        exclude: __init__.py$
 -   repo: https://github.com/ambv/black
     rev: 25.1.0
     hooks:
@@ -36,6 +37,7 @@ repos:
     hooks:
     - id: autoflake
       args: ['--in-place', '--remove-all-unused-imports', '--remove-unused-variable']
+      exclude: __init__.py$
       language_version: python3.12
 -   repo: https://github.com/pycqa/flake8
     rev: 7.3.0

README.md

@@ -1 +1,8 @@
-# d123
+<h1 align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="assets/logo/123D_logo_transparent_white.svg" width="500">
+    <source media="(prefers-color-scheme: light)" srcset="assets/logo/123D_logo_transparent_black.svg" width="500">
+    <img alt="Logo" src="assets/logo/123D_logo_transparent_black.svg" width="500">
+  </picture>
+  <h2 align="center">123D: One Library for 2D and 3D Driving Datasets</h1>
+</h1>