Merge remote-tracking branch 'origin/main' into 219-dependency-groups

# Conflicts:
#	docs/reference/changelog.md

Author: tpvasconcelos

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

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 1
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
 
       - 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@v6
+      - uses: actions/checkout@v7
       - uses: ./.github/actions/setup-python
         with:
           python-version: "3.10"
@@ -68,7 +68,7 @@ jobs:
       DIFF_AGAINST: HEAD
     timeout-minutes: 8
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         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
@@ -104,7 +104,7 @@ jobs:
       # Upload coverage reports to Codecov
 
       - name: Upload coverage to codecov
-        uses: codecov/codecov-action@v6
+        uses: codecov/codecov-action@v7
         env:
           OS: "${{ matrix.os }}"
           PYTHON: "${{ matrix.python-version }}"

.github/workflows/codeql.yml

@@ -29,7 +29,7 @@ jobs:
       # actions: read
       # contents: read
     steps:
-    - uses: actions/checkout@v6
+    - uses: actions/checkout@v7
 
     - 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@v6
+      - uses: actions/checkout@v7
         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
@@ -105,7 +105,7 @@ jobs:
     steps:
 
       # Generate the release notes
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         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
@@ -124,14 +124,14 @@ jobs:
           name: python-package-distributions
           path: dist/
       - name: Sign the dists with Sigstore
-        uses: sigstore/gh-action-sigstore-python@v3.3.0
+        uses: sigstore/gh-action-sigstore-python@v3.4.0
         with:
           inputs: >-
             ./dist/*.tar.gz
             ./dist/*.whl
 
       - name: Create GitHub Release
-        uses: softprops/action-gh-release@v2
+        uses: softprops/action-gh-release@v3
         with:
           body_path: LATEST_RELEASE_NOTES.md
           # `dist/` contains the built distributions, and the

.pre-commit-config.yaml

@@ -43,7 +43,7 @@ repos:
         exclude: ^\.bumpversion\.cfg$
 
   - repo: https://github.com/python-jsonschema/check-jsonschema.git
-    rev: 0.37.2
+    rev: 0.37.4
     hooks:
       - id: check-github-actions
       - id: check-github-workflows
@@ -65,7 +65,7 @@ repos:
       - id: nbstripout
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.4.2
+    rev: v2.4.3
     hooks:
       - id: codespell
         args: [ "-L", "probly", "-L", "mis" ]
@@ -104,7 +104,7 @@ repos:
         additional_dependencies: [setuptools-scm]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.15.13
+    rev: v0.15.22
     hooks:
       - id: ruff-format
       - id: ruff

cicd_utils/ridgeplot_examples/__init__.py

@@ -19,6 +19,12 @@ def load_basic() -> go.Figure:
     return main()
 
 
+def load_basic_dark() -> go.Figure:
+    from ._basic_dark import main
+
+    return main()
+
+
 def load_basic_hist() -> go.Figure:
     from ._basic_hist import main
 
@@ -45,6 +51,7 @@ def load_probly() -> go.Figure:
 
 ALL_EXAMPLES: list[Example] = [
     Example("basic", load_basic),
+    Example("basic_dark", load_basic_dark),
     Example("basic_hist", load_basic_hist),
     Example("lincoln_weather", load_lincoln_weather),
     Example("lincoln_weather_red_blue", load_lincoln_weather_red_blue),

cicd_utils/ridgeplot_examples/_basic.py

@@ -5,15 +5,19 @@
 if TYPE_CHECKING:
     import plotly.graph_objects as go
 
+    from ridgeplot._types import PlotlyTemplate
 
-def main() -> go.Figure:
+
+def main(
+    template: PlotlyTemplate | None = None,
+) -> go.Figure:
     import numpy as np
 
     from ridgeplot import ridgeplot
 
     rng = np.random.default_rng(42)
     my_samples = [rng.normal(n, size=900) for n in range(6, 0, -2)]
-    fig = ridgeplot(samples=my_samples)
+    fig = ridgeplot(samples=my_samples, template=template)
     fig.update_layout(height=400, width=800)
 
     return fig

cicd_utils/ridgeplot_examples/_basic_dark.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from ridgeplot_examples._basic import main as basic
+
+if TYPE_CHECKING:
+    import plotly.graph_objects as go
+
+
+def main() -> go.Figure:
+    fig = basic(template="plotly_dark")
+    return fig
+
+
+if __name__ == "__main__":
+    fig = main()
+    fig.show()

docs/_static/charts/basic_dark.webp

@@ -287,3 +287,20 @@ fig = ridgeplot(
 ```{raw} html
 :file: ../_static/charts/lincoln_weather_red_blue.html
 ```
+
+## Theming with Plotly templates
+
+Since `ridgeplot` is built on top of Plotly, you can also theme your ridgeline plots using [Plotly's figure templates](https://plotly.com/python/templates/). Simply pass the name of a registered template (or any other valid template representation) to the {py:paramref}`~ridgeplot.ridgeplot.template` parameter. For instance, taking the basic example from the top of this page and applying the `"plotly_dark"` template:
+
+```python
+fig = ridgeplot(samples=my_samples, template="plotly_dark")
+fig.show()
+```
+
+```{raw} html
+:file: ../_static/charts/basic_dark.html
+```
+
+:::{note}
+Unless a custom {py:paramref}`~ridgeplot.ridgeplot.colorscale` is specified, the default colorscale will also be inferred from the specified template.
+:::