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

diff v6.1.0…main

Documentation

  • Add link to rstcheck-core for FAQ

6.1.0 (2022-08-14)

diff v6.0.0.post1…v6.1.0

Documentation

  • Add note for incompatibility of typer <0.4.1 and click >=8.1 (#138)

  • Update GitHub URL in installation instructions (#139)

  • Fix broken mega-linter URLs (#136)

  • Update release docs for changed release script

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)

diff v6.0.0…v6.0.0.post1

Miscellaneous

  • Move release date into version headline link

  • Don’t include failing test example in sdist (#128)

6.0.0 (2022-06-04)

diff v6.0.0rc3…v6.0.0

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)

diff v6.0.0rc2…v6.0.0rc3

BREAKING CHANGES

  • MOVED THE CORE LIBRARY INTO IT’S OWN REPOSITORY AT rstcheck/rstcheck-core

  • rstcheck.config.load_config_file_from_path now raises an FileNotFoundError if the given path is neither a file nor a directory (#125)

  • The CLI runner exits 1 when the config path passed with --config does not exist (#125)

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)

diff v6.0.0rc1…v6.0.0rc2

New features

  • Catch SyntaxWarnings in python code-blocks and handle them like SyntaxErrors (#124)

  • Add additional inline configuration and flow control options (#123) (see the config docs for more information)

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)

diff v6.0.0a2…v6.0.0rc1

BREAKING CHANGES

  • find_ignored_languages no longer throws exception but logs warning (#108)

New features

  • Add more thorough documentation (#112)

  • Add --log-level option to CLI (#108)

  • Add --warn-unknown-settings flag to CLI (#118)

  • Setup logging to console for CLI (#108)

  • Setup logging to console for library (deactivated by default) (#108)

v6.0.0a2 (2022-05-20)

diff v6.0.0a1…v6.0.0a2

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)

diff v5.0.0…v6.0.0a1

BREAKING CHANGES

  • Full restructuring of the code base (#100)

  • Rewrite of CLI with typer (#100)

  • Renamed config report to report_level (#100)

  • Renamed config ignore_language to ignore_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

  • Add section with Known limitations / FAQ to the README (#97)

  • Accumulate all errors in rst source instead of only one (#83)

  • Allow errors in code blocks to be ignored via ignore_messages (#100)

  • Add support for TOML config files (#84)

Bugfixes

  • Fix inability to ignore code, code-block and sourcecode directives (#79)

  • Fix code-block options recognition (#62)

  • Fix Malformed tables because of substitutions (#82)

  • Fix: remove include directive from ignore list when sphinx is active (#70)

v5.0.0 (2022-04-17)

diff v4.1.0…v5.0.0

  • Add examples/ to sdist

  • Add Development section to README and update Testing section

  • Add Mega-Linter section to README

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

diff v4.0.0…v4.1.0

  • Fix shebangs and scripts to use python3 instead of python (#78)

  • Improve the gcc checker functions by removing restrictions and using environment variable flags (#88)

  • Fix pool size on windows by setting max to 61 (#86)

  • Update test.bash script and makefile with new file location

v4.0.0 (2022-04-15)

diff v3.5.0…v4.0.0

  • Add inline type annotations

  • Add sphinx as extra

  • Update build process and set up poetry

  • Add pre-commit and tox for automated testing, linting and formatting

  • Move from travis to github actions

  • Activate dependabot

BREAKING CHANGES

  • Drop support for python versions prior 3.7

v3.5.0 (2022-04-14)

diff v3.4.0…v3.5.0

  • Deprecate python versions prior 3.7

v3.4.0 (2022-04-12)

diff v3.3.1…v3.4.0

  • Add --config option to change the location of the config file.

  • Add pre-commit hooks config.

v3.3.1 (2018-11-09)

diff v3.3…v3.3.1

  • Make compatible with Sphinx >= 1.8.

v3.3 (2018-03-17)

diff v3.2…v3.3

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

diff v3.1…v3.2

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

diff v3.0.1…v3.1

  • Add support for checking XML code blocks (thanks to Sameer Singh).

v3.0.1 (2017-03-02)

diff v3.0…v3.0.1

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

diff v2.2…v3.0

  • Optionally support Sphinx 1.5. Sphinx support will be enabled if Sphinx is installed.

v2.0 (2016-07-27)

diff v1.5.1…v2.0

  • Support loading settings from configuration files.

v0.3.1

diff v0.2…v0.3.1

  • Unknown

v0.2

diff v0.1.1…v0.2

  • Unknown

v0.1.1

diff v0.1…v0.1.1

  • Unknown

v0.1 (2013-12-02)

diff a146c93…v0.1

  • Initial version.