Enable spell checking (#563)

* add spellchecking

* improve spelling

* improve spelling config

* extend word list

* improve spelling

* improve spelling

* escalate warning in spell check to failure

* fix spelling

* fix spelling

* add plural

* Update doc/spelling_wordlist.txt

* do not stop on warning

* require newest sphinxcontrib spelling

* remove old comment

* add authors as single line entry to spelling list

* reenable stop on warning

doc/conf.py

@@ -316,3 +316,15 @@ spelling_ignore_pypi_package_names = True
 spelling_ignore_wiki_words = True
 spelling_ignore_python_builtins = True
 spelling_ignore_importable_modules = True
+spelling_ignore_contributor_names = True
+spelling_word_list_filename = ["spelling_wordlist.txt", "../AUTHORS"]
+spelling_show_suggestions = True
+spelling_suggestion_limit = 3
+spelling_warning = True
+spelling_exclude_patterns = [
+    "**/capabilities.json",
+    "../../capabilities-data/dist/capabilities.json",
+    "**/available-encodings.rst",
+    "**/available-profiles.rst",
+    "dev/todo.rst",
+]

doc/dev/repository.rst

@@ -5,13 +5,13 @@ Repository
 
 :Last Reviewed: 2023-09-05
 
-This project uses subprojects and retrieves its versioning
+This project uses sub-projects and retrieves its versioning
 information from version control.
 Therefore it is crucial that you follow these rules when
 working with the project (e.g. for packaging a
 development version).
 
 * Make sure that the git project is complete. A call to git status for example should succeed.
-* Make sure that you have checked out all available subprojects.
+* Make sure that you have checked out all available sub-projects.
 * Proper initialization of submodules can be ensured with ``git submodule update --init --recursive``
 

doc/printer_profiles/capabilities.rst

@@ -21,6 +21,6 @@ The identifier can be found in :ref:`available-profiles`.
 This documentation describes the profiles in the database file that
 is bundled with this release.
 If another configuration is to be used, this chapter can be followed
-for information on how to sideload another `capabilities`-database:
+for information on how to side-load another `capabilities`-database:
 :ref:`advanced-usage-change-capabilities-profile`.
 

doc/spelling_wordlist.txt

@@ -1,7 +1,125 @@
-Raspbian
 ESC
+Esc
 POS
+Pos
 Escpos
 Escpos
+escpos
+
+bitImageColumn
+bitImageRaster
+ep
+pc
+cp
+
+csoft
+Frédéric
+Headcrash
+Krispy
+primax
+Tahri
+reck
+mrwunderbar
+zouppen
+kedare
+Foaly
+brendanhowell
+der
+fvdsn
+Marull
+Paretas
+Kakistocrat
+Billington
+patkan
+Romain
+Bougakov
+Yaisel
+Hurtado
+Wagenbach
+Poca
+Akram
+Vieira
+Christoph
+Heuel
+Thijs
+Triemstra
+Linder
+Romain
+Pulgarin
+Romain
+Cheng
+Dmytro
+Katyukha
+Elsdörfer
+Asuki
+Kono
+López
+mashedkeyboard
+Thijs
+Triemstra
+Elsdörfer
+Renato
+Lorenzi
+Bookham
+Goglin
+Christoph
+Heuel
+Qian
+Lehtonen
+
+barcode
+barcodes
 baudrate
-lsusb
+Bashlinux
+capabilities
+cashdraw
+charcode
+changelog
+cheque
+codebase
+codecov
+codepages
+config
+del
+dev
+dialout
+docstrings
+ean
+Ean
+encodable
+fff
+io
+json
+latin
+libusb
+lp
+lsusb
+natively
+php
+pre
+prefilled
+printcap
+programmatically
+py
+pypy
+pyyaml
+px
+qrcode
+Raspbian
+rebase
+rebased
+resetted
+rst
+submodule
+submodules
+src
+testcases
+th
+Todo
+traceback
+udev
+usb
+usec
+virtualenvs
+whitespaces
+xml

doc/user/barcode.rst

@@ -4,14 +4,14 @@ Printing Barcodes
 :Last Reviewed: 2023-08-10
 
 Many printers implement barcode printing natively.
-This hardware renderered barcodes are fast but the supported
+These hardware rendered barcodes are fast but the supported
 formats are limited by the printer itself and different between models.
 However, almost all printers support printing images, so barcode
 rendering can be performed externally by software and then sent
 to the printer as an image.
 As a drawback, this operation is much slower and the user needs
 to know and choose the image implementation method supported by
-the printer's commandset.
+the printer's command-set.
 
 barcode-method
 ~~~~~~~~~~~~~~

doc/user/installation.rst

@@ -63,7 +63,8 @@ Setup udev for USB-Printers
 
 Enabling tab-completion in CLI
 ------------------------------
-python-escpos has a CLI with tab-completion. This is realised with ``argcomplete``.
+python-escpos has a CLI with tab-completion.
+This is realized with ``argcomplete``.
 In order for this to work you have to enable tab-completion, which is described in
 the `manual of argcomplete <https://argcomplete.readthedocs.io>`__.
 

doc/user/printers.rst

@@ -12,7 +12,7 @@ printers.
 
 .. note::
       This driver is not suited for USB-to-Serial-adapters
-      and similiar devices, but only for those implementing native USB.
+      and similar devices, but only for those implementing native USB.
 
 .. autoclass:: escpos.printer.Usb
     :members:

doc/user/usage.rst

@@ -146,7 +146,7 @@ And for linux::
 
     $HOME/.config/python-escpos/config.yaml
 
-If you aren't sure, run::
+If you are not sure, run::
 
     from escpos import config
     c = config.Config()
@@ -206,10 +206,12 @@ For normal usage you can simply pass your text to the printers ``text()``-functi
 the right codepage and then send the encoded data to the printer. If this feature does not work, please try to
 isolate the error and then create an issue on the GitHub project page.
 
-If you want or need to you can manually set the codepage. For this please use the ``charcode()``-function. You can set
-any key-value that is in ``CHARCODE``. If something is wrong, an ``CharCodeError`` will be raised.
-After you have manually set the codepage the printer won't change it anymore. You can revert to normal behaviour
-by setting charcode to ``AUTO``.
+If you want or need to you can manually set the codepage.
+For this please use the ``charcode()``-function.
+You can set any key-value that is in ``CHARCODE``.
+If something is wrong, an ``CharCodeError`` will be raised.
+After you have manually set the codepage the printer won't change it anymore.
+You can revert to normal behavior by setting charcode to ``AUTO``.
 
 Advanced Usage: Print from binary blob
 --------------------------------------