Changelog#

This document outlines the list of changes to ridgeplot between each release. For full details, see the commit logs.

Unreleased changes#

Use the {raw} html :file: _static/charts/<PLOT-ID>.html directive to load the interactive Plotly graphs in the generated Sphinx docs. The generated HTML artefacts only include a <div> wrapper block now and the plotly.min.js is now vendored and automatically loaded via the html_js_files Sphinx config. (#132)
Small adjustments to the example plots in the documentation. (#132)
Reformat markdown files, removing all line breaks. (#132)

Define a ridgeplot._missing.MISSING sentinel object for internal use (this replaces the multiple module-level _MISSING = object() sentinels). (#154)
Add an internal extras/ directory to place helper modules and packages used in different CI tasks. (#154 and #161)

Replace isort, flake8, and pyupgrade with ruff. (#131)
Add regression tests for the figure artifacts generated by the examples in _ridgeplot_examples. (#154)
Remove the Python locked dependency files. (#163)

The colormode='index' value has been deprecated in favor of colormode='row-index', which provides the same functionality but is more explicit and allows to distinguish between the 'row-index' and 'trace-index' modes. (#114)
The show_annotations argument has been deprecated in favor of show_yticklabels. (#114)
The get_all_colorscale_names() function has been deprecated in favor of list_all_colorscale_names(). (#114)

Add functionality to allow plotting of multiple traces per row. (#114)
Add ridgeplot.datasets.load_lincoln_weather() helper function to load the “Lincoln Weather” toy dataset. (#114)
Add more versions of the probly dataset ("wadefagen" and "illinois"). (#114)
Add support for Python 3.11.

Major update to the documentation, including more examples, interactive plots, script to generate the HTML and WebP images from the example scripts, improved API reference, and more. (#114)

Remove mdformat from the automated CI checks. It can still be triggered manually. (#114)
Improved type annotations and type checking. (#114)

Add ridgeplot.datasets.load_probly() helper function to load the probly toy dataset. The probly.csv file is now included in the package under ridgeplot/datasets/data/. (#80)

Change to numpydoc style docstrings. (#81)
Add a robots.txt to the docs site. (#81)
Auto-generate a site map for the docs site using sphinx_sitemap. (#81)
Change the sphinx theme to furo. (#81)
Improve the internal documentation and some of these internals to the API reference. (#81)

Fixed and improved some type annotations, including the introduction of ridgeplot._types module for type aliases such as Numeric and NestedNumericSequence. (#80)
Add the blacken-docs pre-commit hook and add the pep8-naming, flake8-pytest-style, flake8-simplify, flake8-implicit-str-concat, flake8-bugbear, flake8-rst-docstrings, flake8-rst-docstrings, etc… plugins to the flake8 pre-commit hook. (#81)
Cleanup and improve some type annotations. (#81)
Update deprecated set-output commands (GitHub Actions) (#87)

Automate the release process. See .github/workflows/release.yaml, which issues a new GitHub release whenever a new git tag is pushed to the main branch by extracting the release notes from the changelog.
Fix automated release process to PyPI. (#27)

Upgrade project structure, improve testing and CI checks, and start basic Sphinx docs. (#21)
Implement LazyMapping helper to allow ridgeplot._colors.PLOTLY_COLORSCALES to lazy-load from colors.json (#20)