Skip to content

Commit db2395c

Browse files
committed
Get documentation to build
1 parent a5b7c2d commit db2395c

File tree

4 files changed

+10
-28
lines changed

4 files changed

+10
-28
lines changed

README.rst

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,11 @@ This is easily achieved by downloading
3636
or individual libraries can be installed using
3737
`circup <https://github.com/adafruit/circup>`_.
3838

39-
.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
40-
image from the assets folder in the PCB's GitHub repo.
41-
4239
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/>`_
40+
41+
4342
Installing from PyPI
4443
=====================
45-
.. note:: This library is not available on PyPI yet. Install documentation is included
46-
as a standard element. Stay tuned for PyPI availability!
47-
48-
.. todo:: Remove the above note if PyPI version is/will be available at time of release.
4944

5045
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
5146
PyPI <https://pypi.org/project/adafruit-circuitpython-ble-beacon/>`_.
@@ -96,8 +91,7 @@ Or the following command to update an existing version:
9691
Usage Example
9792
=============
9893

99-
.. todo:: Add a quick, simple example. It and other examples should live in the
100-
examples folder and be included in docs/examples.rst.
94+
See the ``examples/`` folder for more usage examples.
10195

10296
Documentation
10397
=============

adafruit_ble_beacon.py

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,11 @@
1515
Implementation Notes
1616
--------------------
1717
18-
**Hardware:**
19-
20-
.. todo:: Add links to any specific hardware product page(s), or category page(s).
21-
Use unordered list & hyperlink rST inline format: "* `Link Text <url>`_"
22-
2318
**Software and Dependencies:**
2419
2520
* Adafruit CircuitPython firmware for the supported boards:
2621
https://circuitpython.org/downloads
2722
28-
.. todo:: Uncomment or remove the Bus Device and/or the Register library dependencies
29-
based on the library's use of either.
30-
31-
# * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
32-
# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
3323
"""
3424

3525
import struct

docs/examples.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1-
Simple test
2-
------------
1+
Sending and Receiving
2+
---------------------
33

44
Ensure your device works with this simple test.
55

66
.. literalinclude:: ../examples/ble_beacon_simpletest.py
7-
:caption: examples/ble_beacon_simpletest.py
7+
:caption: Receive iBeacon advertisements
8+
:linenos:
9+
10+
.. literalinclude:: ../examples/ble_beacon_sendtest.py
11+
:caption: Send iBeacon advertisements
812
:linenos:

docs/index.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,9 @@ Table of Contents
2424
.. toctree::
2525
:caption: Tutorials
2626

27-
.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
28-
the toctree above for use later.
29-
3027
.. toctree::
3128
:caption: Related Products
3229

33-
.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
34-
the toctree above for use later.
35-
3630
.. toctree::
3731
:caption: Other Links
3832

0 commit comments

Comments
 (0)