404
-Page not found
-From 0db8e3728e1d553f96a90780ed6470f5c2f06b97 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Fri, 6 Feb 2026 13:52:02 +0000 Subject: [PATCH 1/3] Add CI for tests and CD for docs deployment - Added `.github/workflows/ci.yml` to run tests on Python 3.10 and 3.11. - Added `.github/workflows/deploy-docs.yml` to deploy mkdocs to gh-pages. - Updated `pyproject.toml` to include `mkdocs-material` dependency. - Updated `mkdocs.yml` to use `material` theme. - Added `site/` to `.gitignore`. --- .github/workflows/ci.yml | 33 + .github/workflows/deploy-docs.yml | 23 + .gitignore | 1 + mkdocs.yml | 2 + pyproject.toml | 1 + site/404.html | 144 - site/cache/index.html | 194 -- site/css/base.css | 366 --- site/css/bootstrap.min.css | 12 - site/css/bootstrap.min.css.map | 1 - site/css/brands.min.css | 6 - site/css/fontawesome.min.css | 9 - site/css/solid.min.css | 6 - site/css/v4-font-face.min.css | 6 - site/img/favicon.ico | Bin 1150 -> 0 bytes site/img/grid.png | Bin 1458 -> 0 bytes site/index.html | 193 -- site/js/base.js | 287 -- site/js/bootstrap.bundle.min.js | 7 - site/js/bootstrap.bundle.min.js.map | 1 - site/js/darkmode.js | 65 - site/search/lunr.js | 3475 ------------------------ site/search/main.js | 109 - site/search/search_index.json | 1 - site/search/worker.js | 133 - site/sitemap.xml | 3 - site/sitemap.xml.gz | Bin 127 -> 0 bytes site/webfonts/fa-brands-400.ttf | Bin 207972 -> 0 bytes site/webfonts/fa-brands-400.woff2 | Bin 117372 -> 0 bytes site/webfonts/fa-regular-400.ttf | Bin 68004 -> 0 bytes site/webfonts/fa-regular-400.woff2 | Bin 25452 -> 0 bytes site/webfonts/fa-solid-900.ttf | Bin 419720 -> 0 bytes site/webfonts/fa-solid-900.woff2 | Bin 156496 -> 0 bytes site/webfonts/fa-v4compatibility.ttf | Bin 10832 -> 0 bytes site/webfonts/fa-v4compatibility.woff2 | Bin 4792 -> 0 bytes 35 files changed, 60 insertions(+), 5018 deletions(-) create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/deploy-docs.yml delete mode 100644 site/404.html delete mode 100644 site/cache/index.html delete mode 100644 site/css/base.css delete mode 100644 site/css/bootstrap.min.css delete mode 100644 site/css/bootstrap.min.css.map delete mode 100644 site/css/brands.min.css delete mode 100644 site/css/fontawesome.min.css delete mode 100644 site/css/solid.min.css delete mode 100644 site/css/v4-font-face.min.css delete mode 100644 site/img/favicon.ico delete mode 100644 site/img/grid.png delete mode 100644 site/index.html delete mode 100644 site/js/base.js delete mode 100644 site/js/bootstrap.bundle.min.js delete mode 100644 site/js/bootstrap.bundle.min.js.map delete mode 100644 site/js/darkmode.js delete mode 100644 site/search/lunr.js delete mode 100644 site/search/main.js delete mode 100644 site/search/search_index.json delete mode 100644 site/search/worker.js delete mode 100644 site/sitemap.xml delete mode 100644 site/sitemap.xml.gz delete mode 100644 site/webfonts/fa-brands-400.ttf delete mode 100644 site/webfonts/fa-brands-400.woff2 delete mode 100644 site/webfonts/fa-regular-400.ttf delete mode 100644 site/webfonts/fa-regular-400.woff2 delete mode 100644 site/webfonts/fa-solid-900.ttf delete mode 100644 site/webfonts/fa-solid-900.woff2 delete mode 100644 site/webfonts/fa-v4compatibility.ttf delete mode 100644 site/webfonts/fa-v4compatibility.woff2 diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..dbfa573 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,33 @@ +name: CI + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.10", "3.11"] + + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install . + + - name: Run tests + run: | + python -m unittest discover -s tests diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 0000000..6b0028b --- /dev/null +++ b/.github/workflows/deploy-docs.yml @@ -0,0 +1,23 @@ +name: Deploy Docs + +on: + push: + branches: [ main ] + +permissions: + contents: write + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: 3.x + - name: Install dependencies + run: | + pip install . + - name: Deploy + run: mkdocs gh-deploy --force diff --git a/.gitignore b/.gitignore index 813d1b4..1013bf1 100644 --- a/.gitignore +++ b/.gitignore @@ -71,3 +71,4 @@ example/binary_collections/* # symlinked schema */.ndi +site/ diff --git a/mkdocs.yml b/mkdocs.yml index e198e3f..f14b5d3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,6 @@ site_name: NDI-python +theme: + name: material nav: - Home: index.md - Cache: cache.md diff --git a/pyproject.toml b/pyproject.toml index 566bdb0..4e96a4e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -19,6 +19,7 @@ classifiers = [ dependencies = [ "did @ git+https://github.com/VH-Lab/DID-python.git@main", "mkdocs", + "mkdocs-material", "pandas", "requests", "ndi-compress @ git+https://github.com/Waltham-Data-Science/NDI-compress-python", diff --git a/site/404.html b/site/404.html deleted file mode 100644 index 0023f9c..0000000 --- a/site/404.html +++ /dev/null @@ -1,144 +0,0 @@ - - -
- - - - - - - -Page not found
-The ndi.cache module provides a simple in-memory cache for storing data.
Cache classThe Cache class is used to create a new cache object.
__init__(self, maxMemory=10e9, replacement_rule='fifo')Creates a new cache object.
-maxMemory: The maximum amount of memory (in bytes) that the cache can use.replacement_rule: The replacement rule to use when the cache is full. Can be 'fifo', 'lifo', or 'error'.add(self, key, type, data, priority=0)Adds an item to the cache.
-key: The key for the item.type: The type of the item.data: The data to be cached.priority: The priority of the item (higher priority items are less likely to be evicted).lookup(self, key, type)Looks up an item in the cache.
-key: The key for the item.type: The type of the item.Returns the cached item, or None if the item is not found.
This is the documentation for the Python port of the VH-Lab/NDI-matlab project.
-NDI-python is a Python library for interacting with the Neuroscience Data Interface (NDI). It provides a set of tools for managing and analyzing neuroscience data.
-To install the package, you can use pip:
-pip install .
-
-import ndi
-