From f7c2cc3431a6fd5f4f2958ef549efa8f8451ae11 Mon Sep 17 00:00:00 2001 From: Sergey Fedoseev Date: Fri, 7 Jun 2024 13:40:45 +0400 Subject: [PATCH] Better class signatures in docs --- .github/workflows/py-ci.yml | 2 +- docs/api-reference/Bucket.md | 2 +- docs/api-reference/Package.md | 4 ++-- gendocs/build.py | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/py-ci.yml b/.github/workflows/py-ci.yml index b1d36f78cbd..2078d525415 100644 --- a/.github/workflows/py-ci.yml +++ b/.github/workflows/py-ci.yml @@ -54,7 +54,7 @@ jobs: - name: install deps run: | python -m pip install --upgrade pip setuptools - python -m pip install api/python nbconvert git+https://github.com/quiltdata/pydoc-markdown.git@quilt + python -m pip install api/python nbconvert git+https://github.com/quiltdata/pydoc-markdown.git@v2.0.5+quilt3.2 - name: generate docs run: cd gendocs && python build.py - name: show invisible changes via cat diff --git a/docs/api-reference/Bucket.md b/docs/api-reference/Bucket.md index e2b541afff9..7570078cc3a 100644 --- a/docs/api-reference/Bucket.md +++ b/docs/api-reference/Bucket.md @@ -1,5 +1,5 @@ -# Bucket(self, bucket\_uri) {#Bucket} +# Bucket(bucket\_uri) {#Bucket} Bucket interface for Quilt. **\_\_init\_\_** diff --git a/docs/api-reference/Package.md b/docs/api-reference/Package.md index f3b023e165d..647c0ff361e 100644 --- a/docs/api-reference/Package.md +++ b/docs/api-reference/Package.md @@ -1,5 +1,5 @@ -# Package(self) {#Package} +# Package() {#Package} In-memory representation of a package ## manifest @@ -400,7 +400,7 @@ __Returns__ True if the package matches the directory; False otherwise. -# PackageEntry(self, physical\_key, size, hash\_obj, meta) {#PackageEntry} +# PackageEntry(physical\_key, size, hash\_obj, meta) {#PackageEntry} Represents an entry at a logical key inside a package. **\_\_init\_\_** diff --git a/gendocs/build.py b/gendocs/build.py index a9bce7ca5d4..0f1c2dbdef5 100755 --- a/gendocs/build.py +++ b/gendocs/build.py @@ -41,7 +41,7 @@ def install_pydocmd(): except metadata.PackageNotFoundError: version = None - if version and version.endswith(EXPECTED_VERSION_SUFFIX): + if version and EXPECTED_VERSION_SUFFIX in version: return valid_input = ['y', 'n', 'yes', 'no'] @@ -75,7 +75,7 @@ def install_pydocmd(): import pydocmd - if not pydocmd.__version__.endswith(EXPECTED_VERSION_SUFFIX): + if EXPECTED_VERSION_SUFFIX not in pydocmd.__version__: print("Please re-run this script to continue") exit()