From ae5fcee778a24058c3f6773b466d5a3dd159e5ea Mon Sep 17 00:00:00 2001 From: Bane Sullivan <22067021+banesullivan@users.noreply.github.com> Date: Fri, 8 May 2026 12:25:51 -0700 Subject: [PATCH 1/2] Fix Sphinx roles in README that fail twine check --- .github/workflows/build-and-deploy.yml | 3 +++ README.rst | 6 +++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index d74fa5f..da127bd 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -44,6 +44,9 @@ jobs: - name: Build sdist run: pipx run build --sdist + - name: Verify README renders on PyPI (twine check) + run: pipx run twine check --strict dist/*.tar.gz + - name: Install sdist run: pip install dist/*.tar.gz diff --git a/README.rst b/README.rst index 75ae152..e1b286d 100644 --- a/README.rst +++ b/README.rst @@ -28,7 +28,7 @@ PyVista accessor (recommended, ``pyvista >= 0.48``) =================================================== Installing ``pyacvd`` registers an ``acvd`` namespace on every -:class:`pyvista.PolyData`, so uniform remeshing slots straight into a +``pyvista.PolyData``, so uniform remeshing slots straight into a PyVista pipeline. Once ``pyacvd`` is imported (or auto-discovered via PyVista's entry-point system) you can call ``mesh.acvd.(...)`` directly: @@ -51,8 +51,8 @@ The accessor never mutates the source mesh and always returns a fresh one-shot uniform remesh. - ``mesh.acvd.clustering(weights=None, subdivide=0)`` — return a - configured :class:`pyacvd.Clustering` for fine-grained control - (plotting clusters, mixing fast/uniform clustering, etc.). + configured ``pyacvd.Clustering`` for fine-grained control (plotting + clusters, mixing fast/uniform clustering, etc.). - ``mesh.acvd.cluster_ids(n_clusters, ...)`` — per-point cluster id array, useful for visualization. From 25a867706cceb54be67a2d8782da8aa3c35362bd Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 8 May 2026 19:26:38 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- README.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index e1b286d..6a2543e 100644 --- a/README.rst +++ b/README.rst @@ -28,10 +28,9 @@ PyVista accessor (recommended, ``pyvista >= 0.48``) =================================================== Installing ``pyacvd`` registers an ``acvd`` namespace on every -``pyvista.PolyData``, so uniform remeshing slots straight into a -PyVista pipeline. Once ``pyacvd`` is imported (or auto-discovered via -PyVista's entry-point system) you can call ``mesh.acvd.(...)`` -directly: +``pyvista.PolyData``, so uniform remeshing slots straight into a PyVista +pipeline. Once ``pyacvd`` is imported (or auto-discovered via PyVista's +entry-point system) you can call ``mesh.acvd.(...)`` directly: .. code:: python