Changelog¶
This is the changelog of rstcheck
. Releases and their respective
changes are listed here. The order of releases is time and not version based!
For a list of all available releases see the
tags section on Github.
Links on the versions point to PyPI.
Unreleased¶
6.1.2 (2023-03-12)¶
Miscellaneous¶
6.1.1 (2022-11-12)¶
Documentation¶
Add link to rstcheck-core for FAQ
Remove unused pydantic related stuff from docs (#149)
Miscellaneous¶
Remove unused dependencies (docutils & its stubs, pydantic) (#149)
Add python 3.11 to CI
6.1.0 (2022-08-14)¶
Documentation¶
Miscellaneous¶
Fix release script’s changelog insertion
Add pre-commit-ci badge to README
Update development tooling dependencies
Bump lower version constraint on typer from 0.3.2 to 0.4.1 (#138)
6.0.0.post1 (2022-06-05)¶
Miscellaneous¶
Move release date into version headline link
Don’t include failing test example in sdist (#128)
6.0.0 (2022-06-04)¶
New features¶
Add a
--version
flag back. This flag gets its information from the metadata in the virtualenv.
Documentation¶
Finalize v6 migration guide.
Add notice to fix
rstcheck-core
version for needed features.
Miscellaneous¶
Add tox envs to test with sphinx v5.
Update
sphinx
extlinks
config for v5.Bump min version of
rstcheck-core
to v1.0.2.
v6.0.0rc3 (2022-05-28)¶
BREAKING CHANGES¶
New features¶
Add
NONE
as a special config file path, to disable config file loading (#125)
Documentation¶
Update config documentation (#126)
v6.0.0rc2 (2022-05-26)¶
New features¶
Documentation¶
Update links to new repository home at rstcheck/rstcheck
Update config documentation
Miscellaneous¶
Fix release date in changelog for v6.0.0rc1 release
Set the rstcheck pre-commit hook to run in serial to avoid overhead of doubling parallel runs with pre-commit
Little improvements to logging messages
Rename master branch to main
v6.0.0rc1 (2022-05-21)¶
BREAKING CHANGES¶
find_ignored_languages
no longer throws exception but logs warning (#108)
New features¶
v6.0.0a2 (2022-05-20)¶
BREAKING CHANGES¶
String lists for
ignore_*
configs are white-space cleaned at string start and end. Restores behavior of pre v6. (#116)
New features¶
Add support for INI multi-line string back (#116)
Bugfixes¶
Fix bug #113 - sphinx print warnings for overwriting registered nodes (#117)
v6.0.0a1 (2022-05-13)¶
BREAKING CHANGES¶
Full restructuring of the code base (#100)
Rewrite of CLI with
typer
(#100)Renamed config
report
toreport_level
(#100)Renamed config
ignore_language
toignore_languages
(#100)Renamed CLI option
--report
to--report-level
(#100)Renamed CLI option
--ignore-language
to--ignore-languages
(#100)Drop CLI option
--ignore
as alias to--ignore-languages
(#100)Drop CLI option
--debug
(#100)Drop CLI option
--version
; may be added back later (#100)Don’t support multi-line strings in INI files (#100)
Prohibit numbers as report level (#100)
Non-existing files are skipped;
rstcheck non-existing-file.rst
exits 0; may be changed later (#100)Drop support for sphinx < 2.0
Drop default values for directives and roles for sphinx (#65)
CLI options now take precedence over config file options (#96)
New features¶
Bugfixes¶
v5.0.0 (2022-04-17)¶
Add examples/ to sdist
Add
Development
section to README and updateTesting
sectionAdd
Mega-Linter
section to READMEAdd
BREAKING CHANGES
sections to changelog
BREAKING CHANGES¶
Rewrite test.bash script in pytest test cases and run them on Linux in CI
Rewrite old test suite in pytest and AAA style
v4.1.0 (2022-04-16)¶
v4.0.0 (2022-04-15)¶
Add inline type annotations
Add
sphinx
as extraUpdate build process and set up
poetry
Add
pre-commit
andtox
for automated testing, linting and formattingMove from travis to github actions
Activate dependabot
BREAKING CHANGES¶
Drop support for python versions prior 3.7
v3.5.0 (2022-04-14)¶
Deprecate python versions prior 3.7
v3.4.0 (2022-04-12)¶
Add
--config
option to change the location of the config file.Add
pre-commit
hooks config.
v3.3.1 (2018-11-09)¶
Make compatible with Sphinx >= 1.8.
v3.3 (2018-03-17)¶
Parse more options from configuration file (thanks to Santos Gallegos).
Allow ignoring specific (info/warning/error) messages via
--ignore-messages
(thanks to Santos Gallegos).
v3.2 (2018-02-17)¶
Check for invalid Markdown-style links (thanks to biscuitsnake).
Allow configuration to be stored in
setup.cfg
(thanks to Maël Pedretti).Add
--recursive
option to recursively drill down directories to check for all*.rst
files.
v3.1 (2017-03-08)¶
Add support for checking XML code blocks (thanks to Sameer Singh).
v3.0.1 (2017-03-02)¶
Support UTF-8 byte order marks (BOM). Previously,
docutils
would interpret the BOM as a visible character, which would lead to false positives about underlines being too short.
v3.0 (2016-12-19)¶
Optionally support Sphinx 1.5. Sphinx support will be enabled if Sphinx is installed.
v2.2 (2016-10-11)¶
Unknown
v2.1 (2016-10-11)¶
Unknown
v2.0 (2016-07-27)¶
Support loading settings from configuration files.
v1.5.1 (2016-05-29)¶
Unknown
v1.5 (2016-02-03)¶
Unknown
v1.4.2 (2015-12-16)¶
Unknown
v1.4.1 (2015-08-16)¶
Unknown
v1.4 (2015-06-26)¶
Unknown
v1.3.1 (2015-04-14)¶
Unknown
v1.3 (2015-04-11)¶
Unknown
v1.2.1 (2015-04-11)¶
Unknown
v1.2 (2015-04-11)¶
Unknown
v1.1.1 (2015-04-05)¶
Unknown
v1.1 (2015-04-03)¶
Unknown
v1.0 (2015-03-14)¶
Add Sphinx support.
v0.6 (2014-09-25)¶
Unknown
v0.5.1 (2014-08-23)¶
Unknown
v0.5 (2014-06-01)¶
Unknown
v0.4.1 (2014-05-31)¶
Unknown
v0.4 (2014-05-24)¶
Unknown
v0.3.6 (2014-04-12)¶
Unknown
v0.3.5 (2014-01-25)¶
Unknown
v0.3.4 (2013-12-29)¶
Unknown
v0.3.3 (2013-12-28)¶
Unknown
v0.3.2 (2013-12-27)¶
Unknown
v0.3.1¶
Unknown
v0.2¶
Unknown
v0.1.1¶
Unknown
v0.1 (2013-12-02)¶
Initial version.