Rstcheck

Latest version: v6.2.1

Safety actively analyzes 642295 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 2 of 9

6.0.0rc3

[diff v6.0.0rc2...v6.0.0rc3](https://github.com/rstcheck/rstcheck/compare/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](https://github.com/rstcheck/rstcheck/pull/125))
- The CLI runner exits 1 when the config path passed with `--config` does not exist ([125](https://github.com/rstcheck/rstcheck/pull/125))

New features

- Add `NONE` as a special config file path, to disable config file loading ([125](https://github.com/rstcheck/rstcheck/pull/125))

Documentation

- Update config documentation ([126](https://github.com/rstcheck/rstcheck/pull/126))

6.0.0rc2

[diff v6.0.0rc1...v6.0.0rc2](https://github.com/rstcheck/rstcheck/compare/v6.0.0rc1...v6.0.0rc2)

New features

- Catch SyntaxWarnings in python code-blocks and handle them like SyntaxErrors ([124](https://github.com/rstcheck/rstcheck/pull/124))
- Add additional inline configuration and flow control options ([123](https://github.com/rstcheck/rstcheck/pull/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

6.0.0rc1

[diff v6.0.0a2...v6.0.0rc1](https://github.com/rstcheck/rstcheck/compare/v6.0.0a2...v6.0.0rc1)

BREAKING CHANGES

- `find_ignored_languages` no longer throws exception but logs warning ([108](https://github.com/rstcheck/rstcheck/pull/108))

New features

- Add more thorough documentation ([112](https://github.com/rstcheck/rstcheck/pull/112))
- Add `--log-level` option to CLI ([108](https://github.com/rstcheck/rstcheck/pull/108))
- Add `--warn-unknown-settings` flag to CLI ([118](https://github.com/rstcheck/rstcheck/pull/118))
- Setup logging to console for CLI ([108](https://github.com/rstcheck/rstcheck/pull/108))
- Setup logging to console for library (deactivated by default) ([108](https://github.com/rstcheck/rstcheck/pull/108))

6.0.0a2

[diff v6.0.0a1...v6.0.0a2](https://github.com/rstcheck/rstcheck/compare/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](https://github.com/rstcheck/rstcheck/pull/116))

New features

- Add support for INI multi-line string back ([116](https://github.com/rstcheck/rstcheck/pull/116))

Bugfixes

- Fix bug 113 - sphinx print warnings for overwriting registered nodes ([117](https://github.com/rstcheck/rstcheck/pull/117))

6.0.0a1

[diff v5.0.0...v6.0.0a1](https://github.com/rstcheck/rstcheck/compare/v5.0.0...v6.0.0a1)

BREAKING CHANGES

- Full restructuring of the code base ([100](https://github.com/rstcheck/rstcheck/pull/100))
- Rewrite of CLI with `typer` ([100](https://github.com/rstcheck/rstcheck/pull/100))
- Renamed config `report` to `report_level` ([100](https://github.com/rstcheck/rstcheck/pull/100))
- Renamed config `ignore_language` to `ignore_languages` ([100](https://github.com/rstcheck/rstcheck/pull/100))
- Renamed CLI option `--report` to `--report-level` ([100](https://github.com/rstcheck/rstcheck/pull/100))
- Renamed CLI option `--ignore-language` to `--ignore-languages` ([100](https://github.com/rstcheck/rstcheck/pull/100))
- Drop CLI option `--ignore` as alias to `--ignore-languages` ([100](https://github.com/rstcheck/rstcheck/pull/100))
- Drop CLI option `--debug` ([100](https://github.com/rstcheck/rstcheck/pull/100))
- Drop CLI option `--version`; may be added back later ([100](https://github.com/rstcheck/rstcheck/pull/100))
- Don't support multi-line strings in INI files ([100](https://github.com/rstcheck/rstcheck/pull/100))
- Prohibit numbers as report level ([100](https://github.com/rstcheck/rstcheck/pull/100))
- Non-existing files are skipped; `rstcheck non-existing-file.rst` exits 0; may be changed later ([100](https://github.com/rstcheck/rstcheck/pull/100))
- Drop support for sphinx < 2.0
- Drop default values for directives and roles for sphinx ([65](https://github.com/rstcheck/rstcheck/issues/65))
- CLI options now take precedence over config file options ([96](https://github.com/rstcheck/rstcheck/issues/96))

New features

- Add section with `Known limitations / FAQ` to the README ([97](https://github.com/rstcheck/rstcheck/issues/97))
- Accumulate all errors in rst source instead of only one ([83](https://github.com/rstcheck/rstcheck/issues/83))
- Allow errors in code blocks to be ignored via ignore_messages ([100](https://github.com/rstcheck/rstcheck/pull/100))
- Add support for TOML config files ([84](https://github.com/rstcheck/rstcheck/pull/84))

Bugfixes

- Fix inability to ignore `code`, `code-block` and `sourcecode` directives ([79](https://github.com/rstcheck/rstcheck/issues/79))
- Fix `code-block` options recognition ([62](https://github.com/rstcheck/rstcheck/issues/62))
- Fix Malformed tables because of substitutions ([82](https://github.com/rstcheck/rstcheck/pull/82))
- Fix: remove `include` directive from ignore list when sphinx is active ([70](https://github.com/rstcheck/rstcheck/issues/70))

5.0.0

[diff v4.1.0...v5.0.0](https://github.com/rstcheck/rstcheck/compare/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

Page 2 of 9

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.