@@ -17,6 +17,8 @@ Dependencies
17
17
This driver depends on:
18
18
19
19
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython >`_
20
+ * `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice >`_
21
+ * `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register >`_
20
22
21
23
Please ensure all dependencies are available on the CircuitPython filesystem.
22
24
This is easily achieved by downloading
@@ -25,7 +27,7 @@ This is easily achieved by downloading
25
27
Usage Example
26
28
=============
27
29
28
- TODO
30
+ See examples/pca9685_simpletest.py for a demo of the usage.
29
31
30
32
Contributing
31
33
============
@@ -34,10 +36,49 @@ Contributions are welcome! Please read our `Code of Conduct
34
36
<https://github.com/adafruit/Adafruit_CircuitPython_PCA9685/blob/master/CODE_OF_CONDUCT.md> `_
35
37
before contributing to help this project stay welcoming.
36
38
37
- API Reference
38
- =============
39
+ Building locally
40
+ ================
41
+
42
+ To build this library locally you'll need to install the
43
+ `circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools >`_ package.
44
+
45
+ .. code-block :: shell
46
+
47
+ python3 -m venv .env
48
+ source .env/bin/activate
49
+ pip install circuitpython-build-tools
50
+
51
+ Once installed, make sure you are in the virtual environment:
52
+
53
+ .. code-block :: shell
54
+
55
+ source .env/bin/activate
56
+
57
+ Then run the build:
58
+
59
+ .. code-block :: shell
60
+
61
+ circuitpython-build-bundles --filename_prefix adafruit-circuitpython-pca9685 --library_location .
62
+
63
+ Sphinx documentation
64
+ -----------------------
65
+
66
+ Sphinx is used to build the documentation based on rST files and comments in the code. First,
67
+ install dependencies (feel free to reuse the virtual environment from above):
68
+
69
+ .. code-block :: shell
70
+
71
+ python3 -m venv .env
72
+ source .env/bin/activate
73
+ pip install Sphinx sphinx-rtd-theme
74
+
75
+ Now, once you have the virtual environment activated:
76
+
77
+ .. code-block :: shell
39
78
40
- .. toctree ::
41
- :maxdepth: 2
79
+ cd docs
80
+ sphinx-build -E -W -b html . _build/html
42
81
43
- api
82
+ This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
83
+ view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
84
+ locally verify it will pass.
0 commit comments