Skip to content

Commit d5422c0

Browse files
committed
updated README
1 parent 54bf9e8 commit d5422c0

File tree

1 file changed

+24
-13
lines changed

1 file changed

+24
-13
lines changed

README.rst

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@ Introduction
1010
:target: https://discord.gg/nBQh6qu
1111
:alt: Discord
1212
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-
1713
CircuitPython RFM69 packet radio module. This supports basic RadioHead-compatible sending and
1814
receiving of packets with RFM69 series radios (433/915Mhz).
1915

@@ -40,15 +36,7 @@ This is easily achieved by downloading
4036
Usage Example
4137
=============
4238

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.
5240

5341
Contributing
5442
============
@@ -80,3 +68,26 @@ Then run the build:
8068
.. code-block:: shell
8169
8270
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.

0 commit comments

Comments
 (0)