File tree Expand file tree Collapse file tree 1 file changed +24
-13
lines changed Expand file tree Collapse file tree 1 file changed +24
-13
lines changed Original file line number Diff line number Diff line change @@ -10,10 +10,6 @@ Introduction
10
10
:target: https://discord.gg/nBQh6qu
11
11
:alt: Discord
12
12
13
- .. image :: https://travis-ci.org/adafruit/Adafruit_CircuitPython_RFM69.svg?branch=master
14
- :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_RFM69
15
- :alt: Build Status
16
-
17
13
CircuitPython RFM69 packet radio module. This supports basic RadioHead-compatible sending and
18
14
receiving of packets with RFM69 series radios (433/915Mhz).
19
15
@@ -40,15 +36,7 @@ This is easily achieved by downloading
40
36
Usage Example
41
37
=============
42
38
43
- See examples/simpletest.py for a simple demo of the usage.
44
-
45
- API Reference
46
- =============
47
-
48
- .. toctree ::
49
- :maxdepth: 2
50
-
51
- api
39
+ See examples/rfm69_simpletest.py for a simple demo of the usage.
52
40
53
41
Contributing
54
42
============
@@ -80,3 +68,26 @@ Then run the build:
80
68
.. code-block :: shell
81
69
82
70
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-rfm69 --library_location .
71
+
72
+ Sphinx documentation
73
+ -----------------------
74
+
75
+ Sphinx is used to build the documentation based on rST files and comments in the code. First,
76
+ install dependencies (feel free to reuse the virtual environment from above):
77
+
78
+ .. code-block :: shell
79
+
80
+ python3 -m venv .env
81
+ source .env/bin/activate
82
+ pip install Sphinx sphinx-rtd-theme
83
+
84
+ Now, once you have the virtual environment activated:
85
+
86
+ .. code-block :: shell
87
+
88
+ cd docs
89
+ sphinx-build -E -W -b html . _build/html
90
+
91
+ This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
92
+ view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
93
+ locally verify it will pass.
You can’t perform that action at this time.
0 commit comments