Bump sphinx-rtd-theme from 2.0.0 to 3.0.1 (#661)

* Bump sphinx-rtd-theme from 2.0.0 to 3.0.1

Bumps [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme) from 2.0.0 to 3.0.1.
- [Changelog](https://github.com/readthedocs/sphinx_rtd_theme/blob/master/docs/changelog.rst)
- [Commits](https://github.com/readthedocs/sphinx_rtd_theme/compare/2.0.0...3.0.1)

---
updated-dependencies:
- dependency-name: sphinx-rtd-theme
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* remove call to get_html_theme_path

according to deprection warning of sphinx-rtd-theme>=3

* disable broken spelling integration (pypi) and fix spelling

* fix spelling

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Patrick Kanzler <dev@pkanzler.de>

CHANGELOG.rst

@@ -342,7 +342,7 @@ changes
 - changed interface of method `blocktext`, changed behavior of multiple methods, for details refer to the documentation
   on `python-escpos.readthedocs.io <https://python-escpos.readthedocs.io>`_
 - add support for custom cash drawer sequence
-- enforce flake8 on the src-files, test py36 and py37 on travis
+- enforce flake8 on the src-files, test py36 and py37 on Travis
 
 contributors
 ^^^^^^^^^^^^
@@ -375,7 +375,7 @@ contributors
 
 changes
 ^^^^^^^
-- configure readthedocs and travis
+- configure readthedocs and Travis
 - update doc with hint on image preprocessing
 - add fix for printing large images (by splitting them into multiple images)
 
@@ -440,7 +440,7 @@ changes
 - improve the documentation
 - extend support of barcode-codes to type B
 - add function to disable panel-buttons
-- the text-functions are now intended for unicode, the driver will automatically encode the string based on the selected
+- the text-functions are now intended for Unicode, the driver will automatically encode the string based on the selected
   code page
 - the image-functions are now much more flexible
 - added a CLI
@@ -479,7 +479,7 @@ contributors
 --------------------------
 
 - Merge pull request #53 from ldos/master
-    - Extended params for serial printers
+    - Extended parameters for serial printers
     - Sent by ldos <cafeteria.ldosalzira@gmail.com>
 
 2015-04-21 - Version 1.0.5

doc/conf.py

@@ -73,7 +73,7 @@ master_doc = "index"
 
 # General information about the project.
 project = "python-escpos"
-copyright = "2023, python-escpos developers"
+copyright = "2024, python-escpos developers"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -134,7 +134,6 @@ else:
         import sphinx_rtd_theme
 
         html_theme = "sphinx_rtd_theme"
-        html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
     except ImportError:
         print("no sphinx_rtd_theme found, switching to nature")
         html_theme = "default"
@@ -313,7 +312,7 @@ texinfo_documents = [
 # texinfo_no_detailmenu = False
 
 # spellchecker
-spelling_ignore_pypi_package_names = True
+spelling_ignore_pypi_package_names = False
 spelling_ignore_wiki_words = True
 spelling_ignore_python_builtins = True
 spelling_ignore_importable_modules = True

doc/dev/release-process.rst

@@ -5,7 +5,7 @@ Release process
 
 * Update authors file
 * Update changelog
-* Set annotated tag for release and push to public github
+* Set annotated tag for release and push to public GitHub
 * Build wheel
 * Load wheel to PyPi
 * Prepare project for next release with an empty changelog entry

doc/requirements.txt

@@ -2,11 +2,11 @@ pyusb
 Pillow>=2.0
 qrcode>=4.0
 pyserial
-sphinx-rtd-theme==2.0.0
+sphinx-rtd-theme==3.0.1
 setuptools
 setuptools-scm
 docutils>=0.12
-sphinxcontrib-spelling>=7.2.0
+sphinxcontrib-spelling>=8.0.0
 python-barcode>=0.15.0,<1
 importlib-metadata
 importlib_resources

doc/spelling_wordlist.txt

@@ -87,14 +87,18 @@ config
 del
 dev
 dialout
+docstring
 docstrings
 ean
 Ean
 encodable
 Errno
 fff
+formatter
 fullimage
+hw
 io
+img
 json
 latin
 libusb
@@ -104,16 +108,23 @@ natively
 php
 pre
 prefilled
+preprocess
+preprocessing
 printcap
 programmatically
 py
 pypy
+pyserial
+pyusb
 pyyaml
+pywin
 px
 qrcode
 Raspbian
+readthedocs
 rebase
 rebased
+renderer
 resetted
 rst
 submodule
@@ -122,11 +133,13 @@ src
 testcases
 th
 Todo
+tox
 traceback
 udev
 usb
 USBTimeoutError
 usec
 virtualenvs
+viivakoodi
 whitespaces
 xml

doc/user/usage.rst

@@ -142,7 +142,7 @@ format. For windows it is probably at::
 
     %appdata%/python-escpos/config.yaml
 
-And for linux::
+And for Linux::
 
     $HOME/.config/python-escpos/config.yaml
 
@@ -200,7 +200,7 @@ An USB-printer could be defined by::
 Printing text right
 -------------------
 
-Python-escpos is designed to accept unicode.
+Python-escpos is designed to accept Unicode.
 
 For normal usage you can simply pass your text to the printers ``text()``-function. It will automatically guess
 the right code page and then send the encoded data to the printer. If this feature does not work, please try to

examples/weather.py

@@ -69,7 +69,7 @@ def forecast(idx):
     printer.text(" high " + str(hi))
     printer.text(deg)
     printer.text("\n")
-    # take care of pesky unicode dash
+    # take care of pesky Unicode dash
     printer.text(cond.replace("\u2013", "-").encode("utf-8"))
     printer.text("\n \n")
 

src/escpos/cli.py

@@ -522,7 +522,7 @@ def generate_parser() -> argparse.ArgumentParser:
     """Generate an argparse parser."""
     parser = argparse.ArgumentParser(
         description="CLI for python-escpos",
-        epilog="Printer configuration is defined in the python-escpos config"
+        epilog="Printer configuration is defined in the python-escpos configuration "
         "file. See documentation for details.",
     )
 

src/escpos/escpos.py

@@ -877,7 +877,7 @@ class Escpos(object, metaclass=ABCMeta):
         """Print alpha-numeric text.
 
         The text has to be encoded in the currently selected code page.
-        The input text has to be encoded in unicode.
+        The input text has to be encoded in Unicode.
 
         :param txt: text to be printed
         :raises: :py:exc:`~escpos.exceptions.TextError`
@@ -888,7 +888,7 @@ class Escpos(object, metaclass=ABCMeta):
         """Print alpha-numeric text with a newline.
 
         The text has to be encoded in the currently selected code page.
-        The input text has to be encoded in unicode.
+        The input text has to be encoded in Unicode.
 
         :param txt: text to be printed with a newline
         :raises: :py:exc:`~escpos.exceptions.TextError`
@@ -909,7 +909,7 @@ class Escpos(object, metaclass=ABCMeta):
     def block_text(self, txt, font="0", columns=None) -> None:
         """Print text wrapped to specific columns.
 
-        Text has to be encoded in unicode.
+        Text has to be encoded in Unicode.
 
         :param txt: text to be printed
         :param font: font to be used, can be :code:`a` or :code:`b`
@@ -1555,7 +1555,7 @@ class EscposIO:
                 f"{text}",
             ]
 
-        # TODO check unicode handling
+        # TODO check Unicode handling
         # TODO flush? or on print? (this should prob rather be handled by the _raw-method)
         for line in lines:
             self.printer.set(**params)

src/escpos/magicencode.py

@@ -69,7 +69,7 @@ class Encoder:
 
         Gets characters 128-255 for a given code page, as an array.
 
-        :param encoding: The name of the encoding. This must appear in the CodePage list
+        :param encoding: The name of the encoding. This must appear in the code page list
         """
         codepage = CodePages.get_encoding(encoding)
         if "data" in codepage:
@@ -294,7 +294,7 @@ class MagicEncode:
         """Write the text and inject necessary code page switches."""
         if text is not None and type(text) is not str:
             raise Error(
-                f"The supplied text has to be unicode, but is of type {type(text)}."
+                f"The supplied text has to be Unicode, but is of type {type(text)}."
             )
 
         # We always know the current code page; if the new code page