/resplendent

A reStructuredText plugin filter for pyspelling to check spelling errors in reStructuredText during CI checks.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

resplendent

Azure Status Travis Status Appveyor Status PyPI version Python Versions PyPI downloads per month Documentation Status Coverage Status Black

A reStructuredText plugin filter for pyspelling.

More details can be found in the Online Documentation.

Installation

You can install resplendent for Python via pip from PyPI.

$ pip install resplendent

Note: if using Python 3.4 the latest version of lxml only supports python 3.5 and above so install lxml 4.3.4

Prerequisites:

  • docutils
  • pyspelling
  • logdecorator

Download from PyPI.org

https://pypi.org/project/resplendent/

Contributing

Contributions are very welcome, consider using the file an issue to discuss the work before beginning, but if you already have a Pull Request ready then this is no problem, please submit it and it will be very gratefully considered. The Contribution Guidelines outlines the resplendent commitment to ensuring all contributions receive appropriate recognition.

License

Distributed under the terms of the GPLv3 license, "resplendent" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

Additional Documentation: