restructure headings
This commit is contained in:
Patrick Kanzler
parent
8b3f8e41a1
commit
18e79cc3c2
@ -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.
|
||||
|
||||
@ -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
|
||||
|
||||
14
README.rst
14
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
|
||||
.. 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 <https://github.com/mike42/escpos-php>`_.
|
||||
|
||||
Dependencies
|
||||
""""""""""""
|
||||
------------
|
||||
|
||||
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
|
||||
|
||||
Documentation and Usage
|
||||
"""""""""""""""""""""""
|
||||
-----------------------
|
||||
|
||||
The basic usage is:
|
||||
|
||||
@ -89,7 +91,7 @@ The full project-documentation is available on
|
||||
`Read the Docs <https://python-escpos.readthedocs.io>`_.
|
||||
|
||||
Contributing
|
||||
""""""""""""
|
||||
------------
|
||||
|
||||
This project is open for any contribution! Please see
|
||||
`CONTRIBUTING.rst <https://python-escpos.readthedocs.io/en/latest/dev/contributing.html>`_
|
||||
@ -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.
|
||||
|
||||
@ -1,6 +1,5 @@
|
||||
***************
|
||||
Release process
|
||||
***************
|
||||
===============
|
||||
|
||||
* Update authors file
|
||||
* Update changelog
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
Printing Barcodes
|
||||
-----------------
|
||||
|
||||
:Last Reviewed: 2023-05-16
|
||||
|
||||
Many printers implement barcode printing natively.
|
||||
|
||||
@ -1,6 +1,5 @@
|
||||
************
|
||||
Installation
|
||||
************
|
||||
============
|
||||
|
||||
:Last Reviewed: 2016-07-23
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
*******
|
||||
Methods
|
||||
*******
|
||||
=======
|
||||
|
||||
:Last Reviewed: 2017-01-25
|
||||
|
||||
Escpos class
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
********
|
||||
Printers
|
||||
********
|
||||
========
|
||||
|
||||
:Last Reviewed: 2022-11-25
|
||||
|
||||
As of now there are 7 different type of printer implementations.
|
||||
|
||||
@ -1,6 +1,5 @@
|
||||
************
|
||||
Raspberry Pi
|
||||
************
|
||||
============
|
||||
|
||||
:Last Reviewed: 2017-01-05
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
*****
|
||||
Usage
|
||||
*****
|
||||
=====
|
||||
|
||||
:Last Reviewed: 2017-06-10
|
||||
|
||||
Define your printer
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user