File tree Expand file tree Collapse file tree 1 file changed +28
-8
lines changed Expand file tree Collapse file tree 1 file changed +28
-8
lines changed Original file line number Diff line number Diff line change @@ -10,6 +10,10 @@ Introduction
10
10
:target: https://discord.gg/nBQh6qu
11
11
:alt: Discord
12
12
13
+ .. image :: https://travis-ci.org/adafruit/Adafruit_CircuitPython_OneWire.svg?branch=master
14
+ :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_OneWire
15
+ :alt: Build Status
16
+
13
17
Classes for use in communicating with devices on a 1-Wire bus.
14
18
15
19
Dependencies
@@ -35,14 +39,6 @@ Usage Example
35
39
print (" ROM={} \t Family=0x{:02x } " .format(d.rom, d.family_code))
36
40
37
41
38
- API Reference
39
- =============
40
-
41
- .. toctree ::
42
- :maxdepth: 2
43
-
44
- api
45
-
46
42
Contributing
47
43
============
48
44
@@ -73,3 +69,27 @@ Then run the build:
73
69
.. code-block :: shell
74
70
75
71
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-onewire --library_location .
72
+
73
+ Sphinx documentation
74
+ -----------------------
75
+
76
+ Sphinx is used to build the documentation based on rST files and comments in the code. First,
77
+ install dependencies (feel free to reuse the virtual environment from above):
78
+
79
+ .. code-block :: shell
80
+
81
+ python3 -m venv .env
82
+ source .env/bin/activate
83
+ pip install Sphinx sphinx-rtd-theme
84
+
85
+ Now, once you have the virtual environment activated:
86
+
87
+ .. code-block :: shell
88
+
89
+ cd docs
90
+ sphinx-build -E -W -b html . _build/html
91
+
92
+ This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
93
+ view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
94
+ locally verify it will pass.
95
+
You can’t perform that action at this time.
0 commit comments