File tree 1 file changed +25
-9
lines changed
1 file changed +25
-9
lines changed Original file line number Diff line number Diff line change @@ -30,15 +30,7 @@ This is easily achieved by downloading
30
30
Usage Example
31
31
=============
32
32
33
- See examples/simpletest.py for a demo of the usage.
34
-
35
- API Reference
36
- =============
37
-
38
- .. toctree ::
39
- :maxdepth: 2
40
-
41
- api
33
+ See examples/tsl2591_simpletest.py for a demo of the usage.
42
34
43
35
Contributing
44
36
============
@@ -70,3 +62,27 @@ Then run the build:
70
62
.. code-block :: shell
71
63
72
64
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tsl2591 --library_location .
65
+
66
+ Sphinx documentation
67
+ -----------------------
68
+
69
+ Sphinx is used to build the documentation based on rST files and comments in the code. First,
70
+ install dependencies (feel free to reuse the virtual environment from above):
71
+
72
+ .. code-block :: shell
73
+
74
+ python3 -m venv .env
75
+ source .env/bin/activate
76
+ pip install Sphinx sphinx-rtd-theme
77
+
78
+ Now, once you have the virtual environment activated:
79
+
80
+ .. code-block :: shell
81
+
82
+ cd docs
83
+ sphinx-build -E -W -b html . _build/html
84
+
85
+ This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
86
+ view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
87
+ locally verify it will pass.
88
+
You can’t perform that action at this time.
0 commit comments