Merge branch 'main' into pre-commit-ci-update-config

Author: tpvasconcelos

.cursor/worktrees.json

@@ -0,0 +1,5 @@
+{
+  "setup-worktree": [
+    "make init"
+  ]
+}

.github/workflows/check-release-notes.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 1
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - name: Default MISSING_CHANGELOG_ENTRY to 1
         run: echo 'MISSING_CHANGELOG_ENTRY=1' >> "$GITHUB_ENV"

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 6
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - uses: ./.github/actions/setup-python
         with:
           python-version: "3.10"
@@ -64,9 +64,11 @@ jobs:
           # - windows-latest
       fail-fast: true
     runs-on: ${{ matrix.os }}
+    env:
+      DIFF_AGAINST: HEAD
     timeout-minutes: 8
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
         with:
           # TODO: This can be very expensive for large repos. Is there a better way to do this?
           # Fetch all history and tags for setuptools_scm to work
@@ -84,28 +86,20 @@ jobs:
       - name: Run unit tests
         shell: bash
         run: tox -e tests-unit
-        env:
-          DIFF_AGAINST: HEAD
 
       - name: Run E2E tests
         shell: bash
         run: tox -e tests-e2e
-        env:
-          DIFF_AGAINST: HEAD
 
       - name: Test the CI/CD utilities
         shell: bash
         run: tox -e tests-cicd_utils
-        env:
-          DIFF_AGAINST: HEAD
 
       # Combine coverage reports from all test suites
 
       - name: Combine coverage reports
         shell: bash
         run: tox -e coverage-combine
-        env:
-          DIFF_AGAINST: HEAD
 
       # Upload coverage reports to Codecov
 

.github/workflows/codeql.yml

@@ -29,7 +29,7 @@ jobs:
       # actions: read
       # contents: read
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
 
     - uses: github/codeql-action/init@v4
       with:

.github/workflows/release.yml

@@ -32,7 +32,7 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 6
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
         with:
           # TODO: This can be very expensive for large repos. Is there a better way to do this?
           # Fetch all history and tags for setuptools_scm to work
@@ -43,7 +43,7 @@ jobs:
           requirements: tox
       - name: Build source (sdist) and binary (wheel) distributions
         run: tox -e build-dists
-      - uses: actions/upload-artifact@v5
+      - uses: actions/upload-artifact@v6
         with:
           name: python-package-distributions
           path: dist/
@@ -61,7 +61,7 @@ jobs:
     permissions:
       id-token: write  # IMPORTANT: mandatory for trusted publishing
     steps:
-      - uses: actions/download-artifact@v6
+      - uses: actions/download-artifact@v7
         with:
           name: python-package-distributions
           path: dist/
@@ -84,7 +84,7 @@ jobs:
     permissions:
       id-token: write  # IMPORTANT: mandatory for trusted publishing
     steps:
-      - uses: actions/download-artifact@v6
+      - uses: actions/download-artifact@v7
         with:
           name: python-package-distributions
           path: dist/
@@ -105,7 +105,7 @@ jobs:
     steps:
 
       # Generate the release notes
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
         with:
           # TODO: This can be very expensive for large repos. Is there a better way to do this?
           # Fetch all history and tags for setuptools_scm to work
@@ -119,7 +119,7 @@ jobs:
 
       # Sign the package distributions with Sigstore
       # https://github.com/marketplace/actions/gh-action-sigstore-python
-      - uses: actions/download-artifact@v6
+      - uses: actions/download-artifact@v7
         with:
           name: python-package-distributions
           path: dist/

.gitignore

@@ -3,6 +3,7 @@
 # ============================================================================
 
 docs/_static/charts/*.html
+docs/_static/js/plotly.min.js
 docs/api/autogen
 docs/api/public
 

MANIFEST.in

@@ -21,23 +21,25 @@ include docs/Makefile
 include docs/make.bat
 include docs/robots.txt
 include docs/_static/favicon.ico
+exclude docs/_static/js/plotly.min.js
 recursive-include docs *.md *.py *.rst
 recursive-include docs/_static/charts *.webp
 recursive-include docs/_static/css *.css
-recursive-include docs/_static/img *.png *.webp *.svg *.gif *.jpg
+recursive-include docs/_static/img *.png *.webp *.svg *.gif *.jpeg
 recursive-include docs/_static/js *.js
 recursive-include docs/_templates *.html
 prune docs/_build
 prune docs/api/autogen
 prune docs/api/public
 
 # Misc
+recursive-include .cursor *.json
 recursive-include .github *.yml *.yaml
 recursive-include cicd_utils README.md *.py *.sh
 recursive-include misc *.py *.ipynb *.txt *.png
 recursive-include requirements *.txt
 recursive-include tests *.py
-recursive-include tests/e2e/artifacts *.jpeg *.json
+recursive-include tests/e2e/artifacts *.json
 
 # Globally excluded patterns
 recursive-exclude * *.py[cod] *.egg-info __pycache__ .ipynb_checkpoints/*

Makefile

@@ -96,6 +96,7 @@ clean-docs: ## remove documentation build artifacts
 	@echo "==> Removing documentation build artifacts..."
 	@rm -fr docs/_build/ docs/api/autogen/ docs/api/public/
 	@find . -wholename 'docs/_static/charts/*.html' -exec rm -fr {} +
+	@rm -f docs/_static/js/plotly.min.js
 
 
 .PHONY: clean-build

README.md

@@ -46,13 +46,13 @@ The full official documentation can be found at: https://ridgeplot.readthedocs.i
 
 ### Basic example
 
-For those in a hurry, here's a very basic example on how to quickly get started with [ridgeplot()](https://ridgeplot.readthedocs.io/en/stable/api/public/ridgeplot.ridgeplot.html) function.
+For those in a hurry, here's a very basic example on how to quickly get started with the [ridgeplot()](https://ridgeplot.readthedocs.io/en/stable/api/public/ridgeplot.ridgeplot.html) function.
 
 ```python
 import numpy as np
 from ridgeplot import ridgeplot
 
-my_samples = [np.random.normal(n / 1.2, size=600) for n in range(7, 0, -1)]
+my_samples = [np.random.normal(n, size=900) for n in range(6, 0, -2)]
 fig = ridgeplot(samples=my_samples)
 fig.show()
 ```

cicd_utils/ridgeplot_examples/_base.py

@@ -70,6 +70,13 @@ class Example:
 
     def __post_init__(self) -> None:
         self.fig = self.figure_factory()  # pyright: ignore[reportUninitializedInstanceVariable]
+
+        # Both `width` and `height` should be set in all example plots
+        if self.fig.layout.width != 800:
+            raise ValueError("All figures must have width 800")
+        if not isinstance(self.fig.layout.height, int):
+            raise ValueError("All figures must have an explicit height declared")  # noqa: TRY004
+
         round_fig_data(self.fig, sig_figs=8)
 
     def to_json(self) -> str:
@@ -86,8 +93,6 @@ def write_json(self, path: Path) -> None:
     def write_html(self, path: Path, minify_html: bool) -> None:
         fig = deepcopy(self.fig)
 
-        if fig.layout.height is None:
-            raise ValueError("The Figure's layout.height value must be explicitly set.")
         # Overriding the width to None results in a '100%' CSS width.
         # This is achieved by setting the `default_width` parameter
         # in `fig.to_html()` to "100%" (see below).
@@ -140,6 +145,8 @@ def write_webp(self, path: Path) -> None:
             engine="kaleido",
         )
 
+    # This method isn't used anywhere anymore but
+    # will be kept here for potential future use
     def write_jpeg(self, path: Path) -> None:
         fig = deepcopy(self.fig)
         fig = tighten_margins(fig, px=40)