Skip to content

Commit cdca40a

Browse files
committed
cleaning up crumbs
1 parent d04a91f commit cdca40a

File tree

4 files changed

+8
-17
lines changed

4 files changed

+8
-17
lines changed

README.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,6 @@ Installing from PyPI
3131
.. note:: This library is not available on PyPI yet. Install documentation is included
3232
as a standard element. Stay tuned for PyPI availability!
3333

34-
.. todo:: Remove the above note if PyPI version is/will be available at time of release.
35-
If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
36-
3734
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
3835
PyPI <https://pypi.org/project/adafruit-circuitpython-rockblock/>`_. To install for current user:
3936

@@ -59,7 +56,11 @@ To install in a virtual environment in your current project:
5956
Usage Example
6057
=============
6158

62-
.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
59+
.. code-block:: python
60+
61+
import board
62+
import busio
63+
# more later
6364
6465
Contributing
6566
============

adafruit_rockblock.py

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,13 @@
3333
3434
**Hardware:**
3535
36-
.. todo:: Add links to any specific hardware product page(s), or category page(s). Use unordered list & hyperlink rST
37-
inline format: "* `Link Text <url>`_"
36+
* `RockBLOCK 9603 Iridium Satellite Modem <https://www.adafruit.com/product/4521>`_
3837
3938
**Software and Dependencies:**
4039
4140
* Adafruit CircuitPython firmware for the supported boards:
4241
https://github.com/adafruit/circuitpython/releases
4342
44-
.. todo:: Uncomment or remove the Bus Device and/or the Register library dependencies based on the library's use of either.
45-
46-
# * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
47-
# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
4843
"""
4944

5045
# imports

docs/conf.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,10 @@
1616
'sphinx.ext.todo',
1717
]
1818

19-
# TODO: Please Read!
2019
# Uncomment the below if you use native CircuitPython modules such as
2120
# digitalio, micropython and busio. List the modules you use. Without it, the
2221
# autodoc module docs will fail to generate with a warning.
23-
# autodoc_mock_imports = ["digitalio", "busio"]
22+
autodoc_mock_imports = ["busio"]
2423

2524

2625
intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}

docs/index.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,10 @@ Table of Contents
2323
.. toctree::
2424
:caption: Tutorials
2525

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

32-
.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
33-
the toctree above for use later.
29+
RockBLOCK 9603 Iridium Satellite Modem <https://www.adafruit.com/product/4521>
3430

3531
.. toctree::
3632
:caption: Other Links

0 commit comments

Comments
 (0)