Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Note that PyEnchant is unmaintained and fix links #14

Merged
merged 1 commit into from
Apr 12, 2018
Merged

Note that PyEnchant is unmaintained and fix links #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

This package contains sphinxcontrb.spelling, a spelling checker for
Sphinx-based documentation. It uses PyEnchant_ to produce a report
showing misspelled words.
showing misspelled words. Note: PyEnchant is now unmaintained.

Refer to the `main documentation page
<http://www.doughellmann.com/docs/sphinxcontrib.spelling/>`__ for
Expand All @@ -33,4 +33,4 @@ 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: http://www.rfk.id.au/software/pyenchant/
.. _PyEnchant: https://github.com/rfk/pyenchant
4 changes: 2 additions & 2 deletions docs/source/customize.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Input Options
``spelling_word_list_filename=['spelling_wordlist.txt','another_list.txt']``
Same as above, but with several files of correctly spelled words.

.. _PyEnchant tutorial: http://packages.python.org/pyenchant/tutorial.html
.. _PyEnchant tutorial: https://github.com/rfk/pyenchant/blob/master/website/content/tutorial.rst

Output Options
==============
Expand Down Expand Up @@ -90,7 +90,7 @@ to the list of known words for just that document.
Goodger


.. _PyEnchant: http://www.rfk.id.au/software/pyenchant/
.. _PyEnchant: https://github.com/rfk/pyenchant

Custom Word Filters
===================
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ Details
history


.. _PyEnchant: http://www.rfk.id.au/software/pyenchant/
.. _PyEnchant: https://github.com/rfk/pyenchant

.. _Sphinx: http://sphinx.pocoo.org/
6 changes: 1 addition & 5 deletions docs/source/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,7 @@
Installing sphinxcontrib.spelling
=================================

1. Follow the instructions on the PyEnchant_ site to install
**enchant** and then **PyEnchant**.
2. Install the extension with pip: ``pip install sphinxcontrib-spelling``

.. _PyEnchant: http://packages.python.org/pyenchant/
Install the extension with pip: ``pip install sphinxcontrib-spelling``

Configuration
=============
Expand Down