Skip to content
This repository was archived by the owner on May 16, 2023. It is now read-only.

Removed building locally section from README, replaced with documenta… #11

Merged
merged 2 commits into from
Oct 21, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 27 additions & 20 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,38 +29,45 @@ This is easily achieved by downloading
**NOTE:** This library is not supported for smaller non-Express boards like
the Trinket M0, Gemma M0, etc.

Usage Example
=============
Installing from PyPI
====================

See examples/thermal_printer_simpletest.py for a demo of basic printer usage.
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-thermal_printer/>`_. To install for current user:

Contributing
============
.. code-block:: shell

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_Thermal_Printer/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
pip3 install adafruit-circuitpython-thermal_printer

To install system-wide (this may be required in some cases):

Sphinx documentation
-----------------------
.. code-block:: shell

sudo pip3 install adafruit-circuitpython-thermal_printer

Sphinx is used to build the documentation based on rST files and comments in the code. First,
install dependencies (feel free to reuse the virtual environment from above):
To install in a virtual environment in your current project:

.. code-block:: shell

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme
pip3 install adafruit-circuitpython-thermal_printer

Usage Example
=============

Now, once you have the virtual environment activated:
See examples/thermal_printer_simpletest.py for a demo of basic printer usage.

.. code-block:: shell
Contributing
============

cd docs
sphinx-build -E -W -b html . _build/html
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_Thermal_Printer/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.


Documentation
=============

This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
locally verify it will pass.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.