All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- [#27](#27) Sphinx extension classifier - thanks @jdillard!
- [#28](#28): Black dependency for pre-commit - thanks @jdillard!
- Default CSS for lists.
- Linting with pre-commit.
- Breaking change: The package is now named
sphinx-contributors
. - Breaking change: The required Sphinx version is at least 3.0.
- Replaced Travis CI for GitHub Actions.
- Replaced
setup.py
forpyproject.toml
.
- [#1](#1): The directive supports an option to render contributor's avatars - thanks @segfaultxavi!
- [#3])(#3): The docs now explain how to render contributors in a grid view.
- [#4](#4): The directive supports an option to hide the number of commits done by a contributor.
- [#13](#13): Docs for this extesion are now hosted on ReadTheDocs.
- The extension now raises a warning instead of an error if the repository cannot be retrieved. This is especially useful when trying to build docs without internet connection.
- [#2](#2): The directive supports an option to limit the number of contributors.
- The directive supports an option to sort contributors per number of commits.
- The directive supports an option to exclude usernames from the contributors' list.
- Before, the repository name was passed as an option. Now, the directive accepts the repository name as an argument.
- Initial code release