@@ -10,8 +10,12 @@ Introduction
10
10
:target: https://discord.gg/nBQh6qu
11
11
:alt: Discord
12
12
13
+ .. image :: https://travis-ci.org/adafruit/Adafruit_CircuitPython_VL6180X.svg?branch=master
14
+ :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_VL6180X
15
+ :alt: Build Status
16
+
13
17
CircuitPython module for the VL6180X distance sensor. See
14
- examples/simpletest .py for a demo of the usage.
18
+ examples/vl6180x_simpletest .py for a demo of the usage.
15
19
16
20
Dependencies
17
21
=============
@@ -27,15 +31,7 @@ This is easily achieved by downloading
27
31
Usage Example
28
32
=============
29
33
30
- See examples/simpletest.py for a demo of the usage.
31
-
32
- API Reference
33
- =============
34
-
35
- .. toctree ::
36
- :maxdepth: 2
37
-
38
- api
34
+ See examples/vl6180x_simpletest.py for a demo of the usage.
39
35
40
36
Contributing
41
37
============
@@ -67,3 +63,49 @@ Then run the build:
67
63
.. code-block :: shell
68
64
69
65
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-vl6180x --library_location .
66
+
67
+ Sphinx documentation
68
+ -----------------------
69
+
70
+ Sphinx is used to build the documentation based on rST files and comments in the code. First,
71
+ install dependencies (feel free to reuse the virtual environment from above):
72
+
73
+ .. code-block :: shell
74
+
75
+ python3 -m venv .env
76
+ source .env/bin/activate
77
+ pip install Sphinx sphinx-rtd-theme
78
+
79
+ Now, once you have the virtual environment activated:
80
+
81
+ .. code-block :: shell
82
+
83
+ cd docs
84
+ sphinx-build -E -W -b html . _build/html
85
+
86
+ This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
87
+ view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
88
+ locally verify it will pass.
89
+
90
+ Sphinx documentation
91
+ -----------------------
92
+
93
+ Sphinx is used to build the documentation based on rST files and comments in the code. First,
94
+ install dependencies (feel free to reuse the virtual environment from above):
95
+
96
+ .. code-block :: shell
97
+
98
+ python3 -m venv .env
99
+ source .env/bin/activate
100
+ pip install Sphinx sphinx-rtd-theme
101
+
102
+ Now, once you have the virtual environment activated:
103
+
104
+ .. code-block :: shell
105
+
106
+ cd docs
107
+ sphinx-build -E -W -b html . _build/html
108
+
109
+ This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
110
+ view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
111
+ locally verify it will pass.
0 commit comments