sphinxcontrib-spelling 5.4.0

sphinxcontrib-spelling is a spelling checker for Sphinx-based documentation. It uses PyEnchant to produce a report showing misspelled words.

Release Date: 2020-09-05

New Features

  • Added a new filter (sphinxcontrib.spelling.filters.ContributorFilter) that treats contributor names extracted from the git history as spelled correctly, making it easier to refer to the names in acknowledgments . Includes a new configuration option, spelling_ignore_contributor_names to enable it.

sphinxcontrib-spelling 5.3.0

sphinxcontrib-spelling is a spelling checker for Sphinx-based documentation. It uses PyEnchant to produce a report showing misspelled words.

New Features

  • Add a configuration option spelling_exclude_patterns to manage skipping spell checking for some input files. The option uses a list of glob-style patterns that are matched against the source file names relative to the source directory. See the configuration documentation for more details. Contributed by sdelliot.

sphinxcontrib-spelling 5.2.1

sphinxcontrib-spelling is a spelling checker for Sphinx-based documentation. It uses PyEnchant to produce a report showing misspelled words.

Bug Fixes

  • Updated to only create .spelling output files for inputs that generate spelling warnings. Fixes #63.

Details

  • update documentation with example output
  • log files as they are created
  • add separate spelling target in tox
  • only create output files when writing warnings

sphinxcontrib-spelling 5.2.0

sphinxcontrib-spelling is a spelling checker for Sphinx-based documentation. It uses PyEnchant to produce a report showing misspelled words.

New Features

  • The builder is now registered using an entry point, so that if the spelling directive is not used in a project sphinxcontrib.spelling does not need to be included explicitly in the extensions list in conf.py in order to use it with the project on the command line.
  • PyEnchant is an optional dependency. If it is not installed, the spell checker will not work, but the extension can still be initialized. This allows projects that use spell checking to publish their documentation to readthedocs.org, where it is not possible to install PyEnchant.
  • Restore support for parallel builds. Words that do not appear in any configured dictionary are written to a file named based on the input file, with the .rst extension replaced with .spelling. Big thanks to Sviatoslav Sydorenko for helping with that!

Other Notes

  • Start using reno to manage release notes.

Details

  • make parallel write safe
  • report import error when using builder without PyEnchant (contributions by Sviatoslav Sydorenko)
  • clarify logic in sphinxcontrib/spelling/asset.py (contributions by Sviatoslav Sydorenko)
  • Fix docstring in sphinxcontrib/spelling/asset.py (contributions by Sviatoslav Sydorenko)
  • fix markup in docs/source/install.rst (contributions by Sviatoslav Sydorenko)
  • include version number in extension metadata
  • make pyenchant optional for import
  • run documentation builds in parallel for testing
  • restore use of spelling directive in docs
  • support parallel reads
  • add entry point declaration for builder
  • update developer docs
  • add reno for managing release notes

sphinxcontrib-spelling 5.1.2

sphinxcontrib-spelling is a spelling checker for Sphinx-based documentation. It uses PyEnchant to produce a report showing misspelled words.

What’s new in 5.1.2?

  • Mark as unsafe for parallel builds (contributed by Jared Dillard)
  • Add -W arg to sphinx-build in docs so warnings cause error (contributed by Elsa Gonsiorowski, PhD)

sphinxcontrib-spelling 5.1.0

sphinxcontrib-spelling is a spelling checker for Sphinx-based documentation. It uses PyEnchant to produce a report showing misspelled words.

What’s new in 5.1.0?

  • Add an option to show the line containing a misspelling for context (contributed by Huon Wilson)

sphinxcontrib-spelling 4.3.0

sphinxcontrib-spelling is a spelling checker for Sphinx-based documentation. It uses PyEnchant to produce a report showing misspelled words.

What’s new in 4.3.0?

  • Logging: use warning() instead of its deprecated alias (contributed by Sergey Kolosov)
  • Support additional contractions (contributed by David Baumgold)
  • require sphinx >= 2.0.0
  • declare support for python 3.6

sphinxcontrib-spelling 4.2.1

sphinxcontrib-spelling is a spelling checker for Sphinx-based documentation. It uses PyEnchant to produce a report showing misspelled words.

What’s new in 4.2.1?

  • fix remaining logging issue (contributed by Timotheus Kampik)
  • Remove usage of deprecated logging API (contributed by Tim Graham)