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>

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,17 +200,17 @@ 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 codepage and then send the encoded data to the printer. If this feature does not work, please try to
+the right code page 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.
+If you want or need to you can manually set the code page.
 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.
+After you have manually set the code page the printer won't change it anymore.
 You can revert to normal behavior by setting charcode to ``AUTO``.
 
 Resolving bus timeout issues during printing images
@@ -241,7 +241,7 @@ advantage of the fact that `_raw()` accepts binary strings.)
     p._raw(data)
 
 That's all, the printer should then print your data. You can also use this technique to let others reproduce an issue
-that you have found. (Just "print" your commands to a File-printer on your local filesystem.)
+that you have found. (Just "print" your commands to a File-printer on your local file system.)
 However, please keep in mind, that often it is easier and better to just supply the code that you are using.
 
 Here you can download an example, that will print a set of common barcodes: