File tree Expand file tree Collapse file tree 1 file changed +25
-10
lines changed Expand file tree Collapse file tree 1 file changed +25
-10
lines changed Original file line number Diff line number Diff line change @@ -10,7 +10,7 @@ Introduction
10
10
:target: https://discord.gg/nBQh6qu
11
11
:alt: Discord
12
12
13
- .. image :: https://travis-ci.org/adafruit/Adafruit_CircuitPython_TLC59711y .svg?branch=master
13
+ .. image :: https://travis-ci.org/adafruit/Adafruit_CircuitPython_TLC59711 .svg?branch=master
14
14
:target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_TLC59711
15
15
:alt: Build Status
16
16
@@ -29,15 +29,7 @@ This is easily achieved by downloading
29
29
Usage Example
30
30
=============
31
31
32
- See examples/simpletest.py for a demo of the usage.
33
-
34
- API Reference
35
- =============
36
-
37
- .. toctree ::
38
- :maxdepth: 2
39
-
40
- api
32
+ See examples/tlc59711_simpletest.py for a demo of the usage.
41
33
42
34
Contributing
43
35
============
@@ -69,3 +61,26 @@ Then run the build:
69
61
.. code-block :: shell
70
62
71
63
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tlc59711 --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