https://github.com/sphinx-contrib/spelling

A spelling checker for Sphinx-based documentation
https://github.com/sphinx-contrib/spelling

Last synced: about 1 month ago
JSON representation

A spelling checker for Sphinx-based documentation

• Host: GitHub
• URL: https://github.com/sphinx-contrib/spelling
• Owner: sphinx-contrib
• License: bsd-2-clause
• Created: 2017-10-03T15:41:36.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-01-30T16:12:35.000Z (8 months ago)
• Last Synced: 2024-07-21T10:44:48.140Z (about 2 months ago)
• Language: Python
• Homepage: https://sphinxcontrib-spelling.readthedocs.io/en/latest/
• Size: 5.29 MB
• Stars: 81
• Watchers: 4
• Forks: 40
• Open Issues: 16
• Metadata Files:
  • Readme: README
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - spelling - (Python)

README

        
.. -*- mode: rst -*-

=========================

 sphinxcontrib-spelling

=========================

This package contains sphinxcontrib.spelling, a spelling checker for

Sphinx-based documentation.  It uses PyEnchant_ to produce a report

showing misspelled words.

Refer to the `main documentation page

`__ for

installation and setup details.

License

=======

Copyright Doug Hellmann, All Rights Reserved

Permission to use, copy, modify, and distribute this software and its

documentation for any purpose and without fee is hereby granted,

provided that the above copyright notice appear in all copies and that

both that copyright notice and this permission notice appear in

supporting documentation, and that the name of Doug Hellmann not be used

in advertising or publicity pertaining to distribution of the software

without specific, written prior permission.

DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,

INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO

EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR

CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF

USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR

OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR

PERFORMANCE OF THIS SOFTWARE.

.. _PyEnchant: https://github.com/pyenchant/pyenchant