diff --git a/README.md b/README.md index 8ac9384..566e4bf 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,7 @@ The STCC4 is Sensirion's next generation miniature CO2 sensor for indoor air qua The default I²C address of [STCC4](https://sensirion.com/products/catalog/STCC4) is **0x64**. -> [!NOTE] -> The SEK-STCC4 board from Sensirion includes a STCC4 and a SHT4x for temperature and humidity compensation, which is controlled by the STCC4 through the integrated I2C controller interface. The provided examples are designed considering this sensor configuration. + ## Connect the sensor @@ -43,27 +42,12 @@ For special setups you find the sensor pinout in the section below. ## Documentation & Quickstart See the [documentation page](https://sensirion.github.io/python-i2c-stcc4) for an API description and a -[quickstart](https://sensirion.github.io/python-i2c-stcc4/execute-measurements.html) example. +[quickstart](https://sensirion.github.io/python-i2c-stcc4/quickstart.html) example. ## Contributing -### Check coding style - -The coding style can be checked with [`flake8`](http://flake8.pycqa.org/): - -```bash -pip install -e .[test] # Install requirements -flake8 # Run style check -``` - -In addition, we check the formatting of files with -[`editorconfig-checker`](https://editorconfig-checker.github.io/): - -```bash -pip install editorconfig-checker==2.0.3 # Install requirements -editorconfig-checker # Run check -``` +In case you want to contribute to this project, please read the [contribution guidelines]((https://sensirion.github.io/python-i2c-stcc4/contributing.html)). ## License diff --git a/ci/checkin_doc.sh b/ci/checkin_doc.sh deleted file mode 100644 index 1031751..0000000 --- a/ci/checkin_doc.sh +++ /dev/null @@ -1,26 +0,0 @@ -#!/bin/bash - -# set shell settings (see https://sipb.mit.edu/doc/safe-shell/) -set -euv -o pipefail - -# clone the repo into a subfolder html, checkout the gh-pages into this folder and commit the freshly generated html -git clone "git@gitlab:${CI_PROJECT_PATH}.git" html -cd html -git checkout gh-pages -rm -f empty.txt -rm -f *.html -rm -f *.js -rm -rf _* -cd .. -# make sure to copy .nojekyll -cp -rf public/.[!.]* public/* html -cd html -git add . - -if git diff-index --quiet HEAD -- -then - exit 0 -fi - -git commit -m"Automatic doc update: ${CI_COMMIT_SHORT_SHA}" -git push \ No newline at end of file diff --git a/ci/set_git_config.sh b/ci/set_git_config.sh deleted file mode 100644 index 860c6aa..0000000 --- a/ci/set_git_config.sh +++ /dev/null @@ -1,16 +0,0 @@ -#!/bin/bash - -# set shell settings (see https://sipb.mit.edu/doc/safe-shell/) -set -eufv -o pipefail - -# install ssh private key (set as CI variable in GitLab project settings) -mkdir -p ~/.ssh -echo "$SSH_DEPLOY_KEY" > ~/.ssh/id_rsa -chmod 400 ~/.ssh/id_rsa - -# change remote URL to SSH to allow pushing with SSH -git remote set-url --push origin "git@gitlab:${CI_PROJECT_PATH}.git" - -# set git author -git config --global user.name "GitLab-CI" -git config --global user.email "<>" diff --git a/metadata.yml b/metadata.yml index 2b29a43..ab6f86a 100644 --- a/metadata.yml +++ b/metadata.yml @@ -1,7 +1,7 @@ -# driver generation metadata -generator_version: 1.6.1 -model_version: 3.5.1 -dg_status: released -is_manually_modified: false -first_generated: '2025-02-24 11:47' -last_generated: '2026-04-30 12:17' +# driver generation metadata +generator_version: 1.9.1 +model_version: 3.5.1 +dg_status: released +is_manually_modified: false +first_generated: '2025-02-24 11:47' +last_generated: '2026-09-15 17:08' diff --git a/pyproject.toml b/pyproject.toml index 991c888..ba4cb2e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,8 @@ description = "I2C driver for the Sensirion STCC4 sensor family" readme = "README.md" version = "1.1.0" -requires-python = ">=3.8,<4.0" + +requires-python = ">=3.8.4,<4.0" authors = [ { name = "Sensirion", email = "info@sensirion.com" }, @@ -45,8 +46,10 @@ dependencies = [ docs=[ "jinja2~=3.1.6", "sphinx-rtd-theme==3.0.2", - "sphinx==8.2.3", + "sphinx>=7.0,<8.0;python_version < '3.11'", + "sphinx==8.2.3;python_version >= '3.11'", "lazy-object-proxy ~=1.7.1", + "sphinx-tabs~=3.5.0", "sphinx-autoapi~=3.0.0", ]