This repository was archived by the owner on May 16, 2023. It is now read-only.
File tree Expand file tree Collapse file tree 1 file changed +28
-9
lines changed Expand file tree Collapse file tree 1 file changed +28
-9
lines changed Original file line number Diff line number Diff line change @@ -10,6 +10,10 @@ Introduction
10
10
:target: https://discord.gg/nBQh6qu
11
11
:alt: Discord
12
12
13
+ .. image :: https://travis-ci.org/adafruit/Adafruit_CircuitPython_Thermal_Printer.svg?branch=master
14
+ :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_Thermal_Printer
15
+ :alt: Build Status
16
+
13
17
CircuitPython module for control of various small serial thermal printers.
14
18
15
19
Dependencies
@@ -25,15 +29,7 @@ This is easily achieved by downloading
25
29
Usage Example
26
30
=============
27
31
28
- See examples/simpletest.py for a demo of basic printer usage.
29
-
30
- API Reference
31
- =============
32
-
33
- .. toctree ::
34
- :maxdepth: 2
35
-
36
- api
32
+ See examples/thermal_printer_simpletest.py for a demo of basic printer usage.
37
33
38
34
Contributing
39
35
============
@@ -65,3 +61,26 @@ Then run the build:
65
61
.. code-block :: shell
66
62
67
63
circuitpython-build-bundles --filename_prefix adafruit_circuitpython_thermal_printer --library_location .
64
+
65
+ Sphinx documentation
66
+ -----------------------
67
+
68
+ Sphinx is used to build the documentation based on rST files and comments in the code. First,
69
+ install dependencies (feel free to reuse the virtual environment from above):
70
+
71
+ .. code-block :: shell
72
+
73
+ python3 -m venv .env
74
+ source .env/bin/activate
75
+ pip install Sphinx sphinx-rtd-theme
76
+
77
+ Now, once you have the virtual environment activated:
78
+
79
+ .. code-block :: shell
80
+
81
+ cd docs
82
+ sphinx-build -E -W -b html . _build/html
83
+
84
+ This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
85
+ view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
86
+ locally verify it will pass.
You can’t perform that action at this time.
0 commit comments