From 2f48bb5d2b555c88d3a3ef0f70efd8c0a9d47898 Mon Sep 17 00:00:00 2001 From: gegnew Date: Tue, 12 Jul 2022 11:52:20 +0200 Subject: [PATCH 1/4] dep(mkdocs, mkdocstrings): bump to (1.3, 0.19) --- requirements-dev.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements-dev.txt b/requirements-dev.txt index 173ebf53..0e6a779f 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -5,7 +5,7 @@ responses~=0.10 flake8~=3.7 black~=22.3 Pillow~=9.0 -mkdocs~=1.1 +mkdocs~=1.3 mkdocs-material~=7.3 mkdocs-material-extensions~=1.0 -mkdocstrings[python]~=0.18 +mkdocstrings[python]~=0.19 From 43f64462df9fab9975fb49130d74a923a4751276 Mon Sep 17 00:00:00 2001 From: gegnew Date: Tue, 12 Jul 2022 11:52:43 +0200 Subject: [PATCH 2/4] bug(mkdocs): fix typing error in mkdocs build --- cellengine/resources/scaleset.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/cellengine/resources/scaleset.py b/cellengine/resources/scaleset.py index 7c48d8ca..72789974 100644 --- a/cellengine/resources/scaleset.py +++ b/cellengine/resources/scaleset.py @@ -72,11 +72,11 @@ def apply( """Apply the scaleset to a file. Args: - file (_id or FcsFile): The file to which this scaleset will be + file: The file to which this scaleset will be applied. - clamp_q (bool): Clamp the output to the scale's minimum and maximum + clamp_q: Clamp the output to the scale's minimum and maximum values. - in_place (bool): If True, updates the FcsFile.events; if + in_place: If True, updates the FcsFile.events; if False, returns a DataFrame """ if isinstance(file, str): From 36d5ef448fd8cf66868cdd41ee433fc659ee9134 Mon Sep 17 00:00:00 2001 From: Zach Bjornson Date: Sat, 10 Sep 2022 14:33:44 -0700 Subject: [PATCH 3/4] src: remove redundant install steps from verify-docs.yml --- .github/workflows/verify-docs.yml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.github/workflows/verify-docs.yml b/.github/workflows/verify-docs.yml index 082636d1..9eccd082 100644 --- a/.github/workflows/verify-docs.yml +++ b/.github/workflows/verify-docs.yml @@ -19,11 +19,5 @@ jobs: pip install -r requirements.txt pip install -r requirements-dev.txt pip install -e . - - name: Install mkdocs dependencies - run: | - pip install --upgrade pip - pip install mkdocs - pip install mkdocstrings - pip install mkdocs-material - name: Build site run: mkdocs build --strict From dc5b0a5ce74210d3de63587a1826305581407801 Mon Sep 17 00:00:00 2001 From: Zach Bjornson Date: Sat, 10 Sep 2022 14:34:24 -0700 Subject: [PATCH 4/4] src: verify mkdocs build on all branches --- .github/workflows/verify-docs.yml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/workflows/verify-docs.yml b/.github/workflows/verify-docs.yml index 9eccd082..0b25675d 100644 --- a/.github/workflows/verify-docs.yml +++ b/.github/workflows/verify-docs.yml @@ -1,8 +1,5 @@ name: verify mkdocs build -on: - pull_request: - branches: - - master +on: [pull_request] jobs: verify-docs: name: Verify docs