Posted on

sphinxcontrib-spelling 7.0.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 7.0.0?

  • Handle ValueError raised by importlib.util.find_spec (contributions by Rust Saiargaliev)
  • Remove obsolete comment and guard in setup() (contributions by Jon Dufresne)
  • Remove unnecessary UnicodeEncodeError (due to Python 3) (contributions by Jon Dufresne)
  • Use Python 3 super() (contributions by Jon Dufresne)
  • Remove support for end-of-life Python 3.5 (contributions by Jon Dufresne)
  • Simplify and improve tox configuration (contributions by Jon Dufresne)
  • Capitalize “Python” and “Sphinx” in docs and comments (contributions by Jon Dufresne)
  • add support for python 3.9
Posted on

sphinxcontrib-spelling 6.0.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 6.0.0?

  • add release notes for recent changes
  • stop using reno to manage release notes
  • Fix typo: commiters → committers (contributions by Jon Dufresne)
  • Run pyupgrade across the codebase (contributions by Jon Dufresne)
  • Add ‘Framework :: Sphinx :: Extension’ trove classifier (contributions by Jon Dufresne)
  • Move tests out of the install to the top-level of the project (contributions by Jon Dufresne)
  • Document the project as stable and ready for production use (contributions by Jon Dufresne)
  • Add missing trove classifiers for Python-3-only support (contributions by Jon Dufresne)
  • Replace deprecated imp module with importlib (contributions by Jon Dufresne)
  • Pass ‘filters’ as a keyword argument to pyenchant get_tokenizer() (contributions by Jon Dufresne)
  • Remove unused fixtures dependency (contributions by Louis Sautier)
  • document config option to ignore contributor names
Posted on

sphinxcontrib.datatemplates 0.7.0

sphinxcontrib.datatemplates is an extension for Sphinx to render parts of reStructuredText pages from data files in formats like JSON, YAML, XML, and CSV.

What’s new in 0.7.0?

  • add release history to documentation
  • add sphinx builder environment to template context (contributions by Eric Holscher)
  • add a ‘dump’ subcommand to the command line interface
  • cli: create ‘render’ subcommand
  • treat flag options as special
  • add console script “datatemplate”
  • documentation cleanup (contributions by Jan Brohl)
  • pass the entire application config to the template (contributions by Eric Holscher)
  • reorder, rename parser arguments (contributions by Jan Brohl)
  • Add a directive + loader for nodata (contributions by Jan Brohl)
  • I hate invisible lint errors! (contributions by Jan Brohl)
  • Add (very) basic CLI docmentation+example (contributions by Jan Brohl)
  • Add options passthrough (contributions by Jan Brohl)
  • set up test framework
  • add 3.7 and 3.8 to list of supported python versions
  • add html_context to template context (contributions by Eric Holscher)
  • add loaders registry (contributions by Jan Brohl)
  • make directive option conversion results more intuitive (contributions by Jan Brohl)
  • note source-file as dependency (contributions by Jan Brohl)
  • shorten directive documentation and move to code (contributions by Jan Brohl)
  • add travis job to check package settings with twine
  • test system overhaul (contributions by Jan Brohl)
  • pass all options to template, allow unknown options (contributions by Jan Brohl)
Posted on

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.
Posted on

reno 3.2.0

reno is a release notes manager designed with high throughput in mind, supporting fast distributed development teams without introducing additional development processes. The goal is to encourage detailed and accurate release notes for every release.

New Features

  • Add a new configuration option, encoding, to specify the encoding to use when reading release notes file.
  • Add the semver-next command to calculate the next release version based on the available release notes. Three new configuration options (semver_major, semver_minor, and semver_patch) define the sections that should cause different types of version increments.

Details

  • raise the minimum version of pyyaml
  • add semver-next command
  • add release note for encoding option
  • [trivial] Use opendev url for source code link (contributions by Riccardo Pittau)
  • Add config option to set default character encoding (contributions by Matthew Treinish)
  • Some cleanups (contributions by Andreas Jaeger)
Posted on

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.

Posted on

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
Posted on

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

Posted on

beagle 0.3.0

beagle is a command line tool for querying a hound code search service such as http://codesearch.openstack.org

What’s new in 0.3.0?

  • Add repo-pattern usages examples in the doc (contributed by Hervé Beraud)
  • Add an option to filter repositories in search results
  • Refresh python’s versions and their usages (contributed by Hervé Beraud)
Posted on

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)