From 7b1690f31265d2c706f53b4d6bb4e098ea1c8476 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Thu, 28 May 2020 17:08:30 -0400 Subject: [PATCH] Sphinx. --- README.rst | 2 +- docs/conf.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 61b081f..67d8464 100644 --- a/README.rst +++ b/README.rst @@ -61,7 +61,7 @@ To install in a virtual environment in your current project: Usage Example ============= -.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst. +For example usage, see examples/pm25_simpletest.py Contributing ============ diff --git a/docs/conf.py b/docs/conf.py index 4d86b8c..6ae4a86 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,7 +21,7 @@ # 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 = ["digitalio", "busio"] +autodoc_mock_imports = ["adafruit_bus_device", "digitalio"] intersphinx_mapping = {