File tree Expand file tree Collapse file tree 1 file changed +23
-8
lines changed Expand file tree Collapse file tree 1 file changed +23
-8
lines changed Original file line number Diff line number Diff line change @@ -47,14 +47,6 @@ Usage Example
47
47
time.sleep(0.5 )
48
48
49
49
50
- API Reference
51
- =============
52
-
53
- .. toctree ::
54
- :maxdepth: 2
55
-
56
- api
57
-
58
50
Contributing
59
51
============
60
52
@@ -85,3 +77,26 @@ Then run the build:
85
77
.. code-block :: shell
86
78
87
79
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ds2413 --library_location .
80
+
81
+ Sphinx documentation
82
+ -----------------------
83
+
84
+ Sphinx is used to build the documentation based on rST files and comments in the code. First,
85
+ install dependencies (feel free to reuse the virtual environment from above):
86
+
87
+ .. code-block :: shell
88
+
89
+ python3 -m venv .env
90
+ source .env/bin/activate
91
+ pip install Sphinx sphinx-rtd-theme
92
+
93
+ Now, once you have the virtual environment activated:
94
+
95
+ .. code-block :: shell
96
+
97
+ cd docs
98
+ sphinx-build -E -W -b html . _build/html
99
+
100
+ This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
101
+ view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
102
+ locally verify it will pass.
You can’t perform that action at this time.
0 commit comments