diff --git a/.readthedocs.yml b/.readthedocs.yml index ed57d26..48949cd 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,6 +1,7 @@ version: 2 formats: - epub + - pdf build: os: ubuntu-22.04 tools: @@ -11,6 +12,7 @@ build: - gcc - libcups2-dev - python3-dev + - xindy sphinx: configuration: doc/conf.py submodules: diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 8142c29..0fc208b 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,6 +1,6 @@ -********* Changelog -********* +========= + 2023-05-11 - Version 3.0a9 - "Pride Comes Before A Fall" -------------------------------------------------------- This release is the 10th alpha release of the new version 3.0. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 096bbb6..3c918c7 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,6 +1,5 @@ -************ Contributing -************ +============ This project is open to any kind of contribution. You can help with improving the documentation, adding fixes to the code, providing test cases in code or as a description or just spreading the word. Please feel free to create an diff --git a/README.rst b/README.rst index e873f1a..2988d1c 100644 --- a/README.rst +++ b/README.rst @@ -2,14 +2,13 @@ python-escpos - Python library to manipulate ESC/POS Printers ############################################################# +Description +=========== + .. image:: https://readthedocs.org/projects/python-escpos/badge/?version=latest :target: https://python-escpos.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status - -Description ------------ - Python ESC/POS is a library which lets the user have access to all those printers handled by ESC/POS commands, as defined by Epson, from a Python application. diff --git a/doc/conf.py b/doc/conf.py index 50ad559..5fc6101 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -42,6 +42,7 @@ extensions = [ "sphinx.ext.todo", "sphinx.ext.graphviz", "sphinx.ext.inheritance_diagram", + "sphinx.ext.imgconverter", "sphinxcontrib.datatemplates", "sphinxcontrib.spelling", ] @@ -68,7 +69,7 @@ master_doc = "index" # General information about the project. project = "python-escpos" -copyright = "2016, Manuel F Martinez and others" +copyright = "2023, 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 @@ -224,6 +225,8 @@ latex_elements = { #'preamble': '', } +latex_engine = "xelatex" + # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). @@ -232,7 +235,7 @@ latex_documents = [ "index", "python-escpos.tex", "python-escpos Documentation", - "Manuel F Martinez and others", + "python-escpos developers", "manual", ), ] @@ -267,7 +270,7 @@ man_pages = [ "index", "python-escpos", "python-escpos Documentation", - ["Manuel F Martinez and others"], + ["python-escpos developers"], 1, ) ] @@ -286,7 +289,7 @@ texinfo_documents = [ "index", "python-escpos", "python-escpos Documentation", - "Manuel F Martinez and others", + "python-escpos developers", "python-escpos", "One line description of project.", "Miscellaneous", diff --git a/doc/dev/release-process.rst b/doc/dev/release-process.rst index 740560a..6f26bea 100644 --- a/doc/dev/release-process.rst +++ b/doc/dev/release-process.rst @@ -1,6 +1,5 @@ -*************** Release process -*************** +=============== * Update authors file * Update changelog diff --git a/doc/dev/todo.rst b/doc/dev/todo.rst index d23dddf..eb32e97 100644 --- a/doc/dev/todo.rst +++ b/doc/dev/todo.rst @@ -1,6 +1,5 @@ -**** TODO -**** +==== Open points and issues of the project are tracked in the GitHub issues. Some annotations still remain in the code and should be moved over time diff --git a/doc/index.rst b/doc/index.rst index 07ce151..68e3d33 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -5,8 +5,15 @@ .. include:: ../README.rst +####### Content -------- +####### + +User Documentation +================== + +This chapter describes the central points that +are relevant to the user of this library. .. toctree:: :maxdepth: 1 @@ -19,13 +26,26 @@ Content user/usage user/barcode +Printer profiles +================ + +This chapter gives a listing of the available +printer profiles. Details are described in +:ref:`capabilities-profile-intro`. + .. toctree:: :maxdepth: 1 :caption: Printer profiles - printer_profiles/capabilities.rst - printer_profiles/available-profiles.rst - printer_profiles/available-encodings.rst + printer_profiles/capabilities + printer_profiles/available-profiles + printer_profiles/available-encodings + +Developer Documentation +======================= + +This chapter summarizes information for +developers of this library. .. toctree:: :maxdepth: 1 @@ -36,6 +56,12 @@ Content dev/changelog dev/todo +API Documentation +================= + +This chapter contains an auto-generated +documentation of the API of this library. + .. toctree:: :maxdepth: 1 :caption: API Documentation @@ -52,8 +78,9 @@ Content api/codepages api/katakana +################## Indices and tables -================== +################## * :ref:`genindex` * :ref:`modindex` diff --git a/doc/printer_profiles/capabilities.rst b/doc/printer_profiles/capabilities.rst index c2b333a..13c95f1 100644 --- a/doc/printer_profiles/capabilities.rst +++ b/doc/printer_profiles/capabilities.rst @@ -1,3 +1,5 @@ +.. _capabilities-profile-intro: + Capabilities ------------ :Last Reviewed: 2023-07-29 diff --git a/doc/user/barcode.rst b/doc/user/barcode.rst index 11b12a7..bd84cbc 100644 --- a/doc/user/barcode.rst +++ b/doc/user/barcode.rst @@ -1,5 +1,6 @@ Printing Barcodes ----------------- + :Last Reviewed: 2023-05-16 Many printers implement barcode printing natively. diff --git a/doc/user/installation.rst b/doc/user/installation.rst index 4c826b6..6b3b8f8 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -1,6 +1,5 @@ -************ Installation -************ +============ :Last Reviewed: 2016-07-23 diff --git a/doc/user/methods.rst b/doc/user/methods.rst index 5a150ad..e9cb34a 100644 --- a/doc/user/methods.rst +++ b/doc/user/methods.rst @@ -1,6 +1,6 @@ -******* Methods -******* +======= + :Last Reviewed: 2017-01-25 Escpos class diff --git a/doc/user/printers.rst b/doc/user/printers.rst index 7c5ce8f..0918ccc 100644 --- a/doc/user/printers.rst +++ b/doc/user/printers.rst @@ -1,6 +1,6 @@ -******** Printers -******** +======== + :Last Reviewed: 2022-11-25 As of now there are 7 different type of printer implementations. diff --git a/doc/user/raspi.rst b/doc/user/raspi.rst index bb05f5e..9ec8bf9 100644 --- a/doc/user/raspi.rst +++ b/doc/user/raspi.rst @@ -1,6 +1,5 @@ -************ Raspberry Pi -************ +============ :Last Reviewed: 2017-01-05 diff --git a/doc/user/usage.rst b/doc/user/usage.rst index 983dc7b..3a56d5b 100644 --- a/doc/user/usage.rst +++ b/doc/user/usage.rst @@ -1,6 +1,6 @@ -***** Usage -***** +===== + :Last Reviewed: 2017-06-10 Define your printer