Changed stuff to appease the Sphinx

Author: ShawnHymel

.gitignore

@@ -1,6 +1,12 @@
+*.mpy
+.idea
 __pycache__
 _build
 *.pyc
 .env
 build*
 bundles
+*.DS_Store
+.eggs
+dist
+**/*.egg-info

.travis.yml

@@ -27,7 +27,7 @@ install:
   - pip install --force-reinstall pylint==1.9.2
 
 script:
-  - pylint adafruit_boardtest.py
+  - pylint adafruit_boardtest/*.py
   - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
   - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-boardtest --library_location .
   - cd docs && sphinx-build -E -W -b html . _build/html && cd ..

README.rst

@@ -17,7 +17,7 @@ Board test suite for CircuitPython. Run these tests to ensure that a CircuitPyth
 
 Tests can be run individually. Copy code found in each *boardtest_<name>.py* module to your CIRCUITPYTHON device drive, and rename the file *code.py*.
 
-Alternatively, tests can be imported as modules. Copy the desired test file to CIRCUITPYTHON device drive and import the test in your own code. Each test can be run with the `run_test(pins)` function.
+Alternatively, tests can be imported as modules. Copy the desired test file to CIRCUITPYTHON device drive and import the test in your own code. Each test can be run with the ``run_test(pins)`` function.
 
 The *boardtest_suite.py* (in *examples/*) shows how to call tests from within a script. *boardtest_suite.py* runs the following tests:
 
@@ -56,10 +56,10 @@ You will need the following components:
 
 Connect the components as shown to your board. Note that you can use a 220 Ohm or 330 Ohm resistor for the LED.
 
-.. image:: docs/test_jig.png
+.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BoardTest/blob/master/docs/test_jig.png
     :alt: Test jig Fritzing diagram
 
-To use each test, import the library, find the pins available on your board, and call `boardtest_<test name>.run_test(pins)`. To run the GPIO test, for example:
+To use each test, import the library, find the pins available on your board, and call ``boardtest_<test name>.run_test(pins)``. To run the GPIO test, for example:
 
 .. code:: python
 

adafruit_boardtest/boardtest_gpio.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`GPIO Test`
+`adafruit_boardtest.boardtest_gpio`
 ====================================================
 Toggles all available GPIO on a board. Verify their operation with an LED,
 multimeter, another microcontroller, etc.

adafruit_boardtest/boardtest_i2c.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`I2C Test`
+`adafruit_boardtest.boardtest_i2c`
 ====================================================
 Performs random writes and reads to I2C EEPROM.
 

adafruit_boardtest/boardtest_led.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`LED Test`
+`adafruit_boardtest.boardtest_led`
 ====================================================
 Toggles all available onboard LEDs. You will need to manually verify their
 operation by watching them.

adafruit_boardtest/boardtest_sd.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`SD Test`
+`adafruit_boardtest.boardtest_sd`
 ====================================================
 Performs random writes and reads to SD card over SPI.
 

adafruit_boardtest/boardtest_sd_cd.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`SD CD Test`
+`adafruit_boardtest.boardtest_sd_cd`
 ====================================================
 Reports the output of an SD card's chip detect (CD) pin.
 

adafruit_boardtest/boardtest_spi.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`SPI Test`
+`adafruit_boardtest.boardtest_spi`
 ====================================================
 Performs random writes and reads to SPI EEPROM.
 

adafruit_boardtest/boardtest_uart.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`UART Test`
+`adafruit_boardtest.boardtest_uart`
 ====================================================
 Performs random writes and reads across UART. Connect a wire from TX pin to RX pin.
 

adafruit_boardtest/boardtest_voltage_monitor.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`Voltage Monitor Test`
+`adafruit_boardtest.boardtest_voltage_monitor`
 ====================================================
 Prints out the measured voltage on any onboard voltage/battery monitor pins.
 Note that some boards have an onboard voltage divider to decrease the voltage

docs/api.rst

@@ -1,23 +1,23 @@
-.. automodule:: boardtest_gpio
+.. automodule:: adafruit_boardtest.boardtest_gpio
    :members:
 
-.. automodule:: boardtest_i2c
+.. automodule:: adafruit_boardtest.boardtest_i2c
    :members:
 
-.. automodule:: boardtest_led
+.. automodule:: adafruit_boardtest.boardtest_led
    :members:
 
-.. automodule:: boardtest_sd
+.. automodule:: adafruit_boardtest.boardtest_sd
    :members:
 
-.. automodule:: boardtest_sd_cd
+.. automodule:: adafruit_boardtest.boardtest_sd_cd
    :members:
 
-.. automodule:: boardtest_spi
+.. automodule:: adafruit_boardtest.boardtest_spi
    :members:
 
-.. automodule:: boardtest_uart
+.. automodule:: adafruit_boardtest.boardtest_uart
    :members:
 
-.. automodule:: boardtest_voltage_monitor
-   :members:
+.. automodule:: adafruit_boardtest.boardtest_voltage_monitor
+   :members:

docs/conf.py

@@ -20,7 +20,9 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-autodoc_mock_imports = ["supervisor", "storage"]
+autodoc_mock_imports = ["supervisor", "storage", "analogio", "boardtest_gpio", "boardtest_i2c",
+                        "boardtest_led", "boardtest_sd", "boardtest_sd_cd", "boardtest_spi",
+                        "boardtest_uart", "boardtest_voltage_monitor"]
 
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}

docs/index.rst

@@ -23,14 +23,13 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
+    Installing CircuitPython on SAMD21 Boards <https://learn.adafruit.com/installing-circuitpython-on-samd21-boards>
 
 .. toctree::
     :caption: Related Products
 
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
+    Adafruit Feather M0 Basic Proto <https://www.adafruit.com/product/2772>
+    Arduino MKR Zero <https://store.arduino.cc/arduino-mkrzero>
 
 .. toctree::
     :caption: Other Links

examples/boardtest_suite.py

@@ -65,12 +65,12 @@
 
 import board
 
-import boardtest_led
-import boardtest_gpio
-import boardtest_voltage_monitor
-import boardtest_uart
-import boardtest_spi
-import boardtest_i2c
+from adafruit_boardtest import boardtest_led
+from adafruit_boardtest import boardtest_gpio
+from adafruit_boardtest import boardtest_voltage_monitor
+from adafruit_boardtest import boardtest_uart
+from adafruit_boardtest import boardtest_spi
+from adafruit_boardtest import boardtest_i2c
 
 # Constants
 UART_TX_PIN_NAME = 'TX'