Changelog#

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

Unreleased changes#

  • …

0.1.21#

Features#

  • 🔧 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)

Documentation#

  • 📝 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)

Internal#

  • 🔧 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)

0.1.17#

  • 🔧 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)

0.1.16#

  • 🔧 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)

0.1.14#

  • 📦 Remove named_colorscales from public API (#18)

0.1.13#

  • 🧪 Add tests for example scripts (#14)

0.1.12#

Internal#

  • 📦 Update and standardise CI steps (#6)

Documentation#

  • 📚 Publish official contribution guidelines (CONTRIBUTING.md) (#8)

  • 📚 Publish an official Code of Conduct (CODE_OF_CONDUCT.md) (#7)

  • 📚 Publish an official release/change log (CHANGES.md) (#6)

0.1.11#

  • 🐛 colors.json was missing from the final distributions (#2)

0.1.0#

  • 🚀 Initial release!