setop/python-escpos
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

restructure headings

Browse Source
This commit is contained in:
Patrick Kanzler 2023-08-09 00:23:52 +02:00
parent 8b3f8e41a1
commit 18e79cc3c2
12 changed files with 57 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.rst
View File

@ -1,6 +1,6 @@
*********
Changelog Changelog
********* =========
2023-05-11 - Version 3.0a9 - "Pride Comes Before A Fall" 2023-05-11 - Version 3.0a9 - "Pride Comes Before A Fall"
-------------------------------------------------------- --------------------------------------------------------
This release is the 10th alpha release of the new version 3.0. This release is the 10th alpha release of the new version 3.0.

3
CONTRIBUTING.rst
View File

@ -1,6 +1,5 @@
************
Contributing Contributing
************ ============
This project is open to any kind of contribution. You can help with improving the documentation, adding fixes to the 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 code, providing test cases in code or as a description or just spreading the word. Please feel free to create an

12
README.rst
View File

@ -2,13 +2,15 @@
python-escpos - Python library to manipulate ESC/POS Printers python-escpos - Python library to manipulate ESC/POS Printers
############################################################# #############################################################
.. only:: html
.. image:: https://readthedocs.org/projects/python-escpos/badge/?version=latest .. image:: https://readthedocs.org/projects/python-escpos/badge/?version=latest
:target: https://python-escpos.readthedocs.io/en/latest/?badge=latest :target: https://python-escpos.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status :alt: Documentation Status
Description Description
""""""""""" ===========
Python ESC/POS is a library which lets the user have access to all those printers handled 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. 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 <https://github.com/mike42/escpos-php>`_. `escpos-php <https://github.com/mike42/escpos-php>`_.
Dependencies Dependencies
"""""""""""" ------------
This library makes use of: This library makes use of:
@ -38,7 +40,7 @@ This library makes use of:
* `python-barcode <https://github.com/WhyNotHugo/python-barcode>`_ for the generation of barcodes * `python-barcode <https://github.com/WhyNotHugo/python-barcode>`_ for the generation of barcodes
Documentation and Usage Documentation and Usage
""""""""""""""""""""""" -----------------------
The basic usage is: The basic usage is:
@ -89,7 +91,7 @@ The full project-documentation is available on
`Read the Docs <https://python-escpos.readthedocs.io>`_. `Read the Docs <https://python-escpos.readthedocs.io>`_.
Contributing Contributing
"""""""""""" ------------
This project is open for any contribution! Please see This project is open for any contribution! Please see
`CONTRIBUTING.rst <https://python-escpos.readthedocs.io/en/latest/dev/contributing.html>`_ `CONTRIBUTING.rst <https://python-escpos.readthedocs.io/en/latest/dev/contributing.html>`_
@ -97,7 +99,7 @@ for more information.
Disclaimer Disclaimer
"""""""""" ----------
None of the vendors cited in this project agree or endorse any of the None of the vendors cited in this project agree or endorse any of the
patterns or implementations. patterns or implementations.

3
doc/dev/release-process.rst
View File

@ -1,6 +1,5 @@
***************
Release process Release process
*************** ===============
* Update authors file * Update authors file
* Update changelog * Update changelog

3
doc/dev/todo.rst
View File

@ -1,6 +1,5 @@
****
TODO TODO
**** ====
Open points and issues of the project are tracked in the GitHub issues. 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 Some annotations still remain in the code and should be moved over time

54
doc/index.rst
View File

@ -9,16 +9,22 @@
Content Content
####### #######
User Documentation
==================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
:caption: User Documentation :caption: User Documentation
user/installation user/installation.rst
user/methods user/methods.rst
user/printers user/printers.rst
user/raspi user/raspi.rst
user/usage user/usage.rst
user/barcode user/barcode.rst
Printer profiles
================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -28,30 +34,36 @@ Content
printer_profiles/available-profiles.rst printer_profiles/available-profiles.rst
printer_profiles/available-encodings.rst printer_profiles/available-encodings.rst
Developer Documentation
=======================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
:caption: Developer Documentation :caption: Developer Documentation
dev/release-process dev/release-process.rst
dev/contributing dev/contributing.rst
dev/changelog dev/changelog.rst
dev/todo dev/todo.rst
API Documentation
=================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
:caption: API Documentation :caption: API Documentation
api/escpos api/escpos.rst
api/printer api/printer.rst
api/constants api/constants.rst
api/exceptions api/exceptions.rst
api/capabilities api/capabilities.rst
api/config api/config.rst
api/image api/image.rst
api/cli api/cli.rst
api/magicencode api/magicencode.rst
api/codepages api/codepages.rst
api/katakana api/katakana.rst
################## ##################
Indices and tables Indices and tables

1
doc/user/barcode.rst
View File

@ -1,5 +1,6 @@
Printing Barcodes Printing Barcodes
----------------- -----------------
:Last Reviewed: 2023-05-16 :Last Reviewed: 2023-05-16
Many printers implement barcode printing natively. Many printers implement barcode printing natively.

3
doc/user/installation.rst
View File

@ -1,6 +1,5 @@
************
Installation Installation
************ ============
:Last Reviewed: 2016-07-23 :Last Reviewed: 2016-07-23

4
doc/user/methods.rst
View File

@ -1,6 +1,6 @@
*******
Methods Methods
******* =======
:Last Reviewed: 2017-01-25 :Last Reviewed: 2017-01-25
Escpos class Escpos class

4
doc/user/printers.rst
View File

@ -1,6 +1,6 @@
********
Printers Printers
******** ========
:Last Reviewed: 2022-11-25 :Last Reviewed: 2022-11-25
As of now there are 7 different type of printer implementations. As of now there are 7 different type of printer implementations.

3
doc/user/raspi.rst
View File

@ -1,6 +1,5 @@
************
Raspberry Pi Raspberry Pi
************ ============
:Last Reviewed: 2017-01-05 :Last Reviewed: 2017-01-05

4
doc/user/usage.rst
View File

@ -1,6 +1,6 @@
*****
Usage Usage
***** =====
:Last Reviewed: 2017-06-10 :Last Reviewed: 2017-06-10
Define your printer Define your printer