From 18e79cc3c2858d4e9195732a1a4068be0b4e7c06 Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Wed, 9 Aug 2023 00:23:52 +0200 Subject: [PATCH] restructure headings --- CHANGELOG.rst | 4 +-- CONTRIBUTING.rst | 3 +-- README.rst | 18 +++++++------ doc/dev/release-process.rst | 3 +-- doc/dev/todo.rst | 3 +-- doc/index.rst | 54 ++++++++++++++++++++++--------------- doc/user/barcode.rst | 1 + doc/user/installation.rst | 3 +-- doc/user/methods.rst | 4 +-- doc/user/printers.rst | 4 +-- doc/user/raspi.rst | 3 +-- doc/user/usage.rst | 4 +-- 12 files changed, 57 insertions(+), 47 deletions(-) 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 4db6d5a..895f4af 100644 --- a/README.rst +++ b/README.rst @@ -2,13 +2,15 @@ python-escpos - Python library to manipulate ESC/POS Printers ############################################################# -.. image:: https://readthedocs.org/projects/python-escpos/badge/?version=latest - :target: https://python-escpos.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status +.. only:: html + + .. 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. @@ -27,7 +29,7 @@ settings for the printer that you set. These settings are handled by `escpos-php `_. Dependencies -"""""""""""" +------------ This library makes use of: @@ -38,7 +40,7 @@ This library makes use of: * `python-barcode `_ for the generation of barcodes Documentation and Usage -""""""""""""""""""""""" +----------------------- The basic usage is: @@ -89,7 +91,7 @@ The full project-documentation is available on `Read the Docs `_. Contributing -"""""""""""" +------------ This project is open for any contribution! Please see `CONTRIBUTING.rst `_ @@ -97,7 +99,7 @@ for more information. Disclaimer -"""""""""" +---------- None of the vendors cited in this project agree or endorse any of the patterns or implementations. 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 fa1e949..b68aeae 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -9,16 +9,22 @@ Content ####### +User Documentation +================== + .. toctree:: :maxdepth: 1 :caption: User Documentation - user/installation - user/methods - user/printers - user/raspi - user/usage - user/barcode + user/installation.rst + user/methods.rst + user/printers.rst + user/raspi.rst + user/usage.rst + user/barcode.rst + +Printer profiles +================ .. toctree:: :maxdepth: 1 @@ -28,30 +34,36 @@ Content printer_profiles/available-profiles.rst printer_profiles/available-encodings.rst +Developer Documentation +======================= + .. toctree:: :maxdepth: 1 :caption: Developer Documentation - dev/release-process - dev/contributing - dev/changelog - dev/todo + dev/release-process.rst + dev/contributing.rst + dev/changelog.rst + dev/todo.rst + +API Documentation +================= .. toctree:: :maxdepth: 1 :caption: API Documentation - api/escpos - api/printer - api/constants - api/exceptions - api/capabilities - api/config - api/image - api/cli - api/magicencode - api/codepages - api/katakana + api/escpos.rst + api/printer.rst + api/constants.rst + api/exceptions.rst + api/capabilities.rst + api/config.rst + api/image.rst + api/cli.rst + api/magicencode.rst + api/codepages.rst + api/katakana.rst ################## Indices and tables 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