diff --git a/readthedocs.yml b/.readthedocs.yml similarity index 61% rename from readthedocs.yml rename to .readthedocs.yml index a3a16c1..78a4671 100644 --- a/readthedocs.yml +++ b/.readthedocs.yml @@ -1,2 +1,4 @@ +python: + version: 3 requirements_file: requirements.txt diff --git a/.travis.yml b/.travis.yml index 65862d3..36ca9b5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,15 +16,16 @@ deploy: provider: releases api_key: $GITHUB_TOKEN file_glob: true - file: bundles/* + file: $TRAVIS_BUILD_DIR/bundles/* skip_cleanup: true on: tags: true install: - - pip install pylint circuitpython-build-tools + - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme script: - pylint adafruit_dht.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-dht --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html diff --git a/README.rst b/README.rst index 08f601d..5748e01 100644 --- a/README.rst +++ b/README.rst @@ -6,9 +6,10 @@ Introduction :target: https://circuitpython.readthedocs.io/projects/dht/en/latest/ :alt: Documentation Status -.. image :: https://badges.gitter.im/adafruit/circuitpython.svg - :target: https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge - :alt: Gitter + +.. image :: https://img.shields.io/discord/327254708534116352.svg + :target: https://discord.gg/nBQh6qu + :alt: Discord CircuitPython support for the DHT11 and DHT22 temperature and humidity devices. @@ -23,17 +24,17 @@ This is easily achieved by downloading `the Adafruit library and driver bundle `_. Usage Example -============= +============== Hardware Set-up ---------------- +---------------- The DHT11 and DHT22 devices both need a pull-resistor on the data signal wire. This resistor is in the range of 1k to 5k. Please check your device datasheet for the appropriate value. Basics ------- +------- Of course, you must import the library to use it: @@ -60,7 +61,7 @@ OR initialize the DHT22 device: dht_device = adafruit_dht.DHT22() Read temperature and humidity ----------------------------- +------------------------------ Now get the temperature and humidity values @@ -79,10 +80,50 @@ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. -API Reference -============= +Building locally +================ + +To build this library locally you'll need to install the +`circuitpython-build-tools `_ package. + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install circuitpython-build-tools + +Once installed, make sure you are in the virtual environment: + +.. code-block:: shell + + source .env/bin/activate + +Then run the build: + +.. code-block:: shell + + circuitpython-build-bundles --filename_prefix adafruit-circuitpython-veml6070 --library_location . + +Sphinx documentation +----------------------- + +Sphinx is used to build the documentation based on rST files and comments in the code. First, +install dependencies (feel free to reuse the virtual environment from above): + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install Sphinx sphinx-rtd-theme + +Now, once you have the virtual environment activated: + +.. code-block:: shell + + cd docs + sphinx-build -E -W -b html . _build/html -.. toctree:: - :maxdepth: 2 +This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to +view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to +locally verify it will pass. - api diff --git a/api.rst b/api.rst deleted file mode 100644 index e69910e..0000000 --- a/api.rst +++ /dev/null @@ -1,6 +0,0 @@ - -DHT Libary Documentation -============================ - -.. automodule:: adafruit_dht - :members: diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000..5aca983 Binary files /dev/null and b/docs/_static/favicon.ico differ diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..8cf4027 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,5 @@ + +.. If you created a package, create one automodule per module in the package. + +.. automodule:: adafruit_dht + :members: diff --git a/conf.py b/docs/conf.py similarity index 90% rename from conf.py rename to docs/conf.py index 01567df..c853a13 100644 --- a/conf.py +++ b/docs/conf.py @@ -2,7 +2,7 @@ import os import sys -sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath('..')) # -- General configuration ------------------------------------------------ @@ -28,7 +28,7 @@ source_suffix = '.rst' # The master toctree document. -master_doc = 'README' +master_doc = 'index' # General information about the project. project = u'Adafruit CircuitPython DHT Library' @@ -54,7 +54,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md'] # The reST default role (used for this markup: `text`) to use for all # documents. @@ -71,6 +71,9 @@ # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False +# If this is True, todo emits a warning for each TODO entries. The default is False. +todo_emit_warnings = True + # -- Options for HTML output ---------------------------------------------- @@ -95,6 +98,12 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +html_favicon = '_static/favicon.ico' + # Output file base name for HTML help builder. htmlhelp_basename = 'AdafruitCircuitPythonDHTLibrarydoc' diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000..10e4456 --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,8 @@ +Simple test +------------ + +Ensure your device works with this simple test. + +.. literalinclude:: ../examples/dht_simpletest.py + :caption: examples/dht_simpletest.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..2c9e99b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,49 @@ +.. include:: ../README.rst + +Table of Contents +================= + +.. toctree:: + :maxdepth: 4 + :hidden: + + self + +.. toctree:: + :caption: Examples + + examples + +.. toctree:: + :caption: API Reference + :maxdepth: 3 + + api + +.. toctree:: + :caption: Tutorials + +.. toctree:: + :caption: Related Products + + DHT11 basic temperature-humidity sensor + extras + + DHT22 basic temperature-humidity sensor + extras + +.. toctree:: + :caption: Other Links + + Download + CircuitPython Reference Documentation + CircuitPython Support Forum + Discord Chat + Adafruit Learning System + Adafruit Blog + Adafruit Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/examples/dht_simpletest.py b/examples/dht_simpletest.py new file mode 100644 index 0000000..ef2e81c --- /dev/null +++ b/examples/dht_simpletest.py @@ -0,0 +1,18 @@ +import time +import adafruit_dht +from board import D2 + +#initial the dht device +dhtDevice = adafruit_dht.DHT22(D2) + +while True: + try: + # show the values to the serial port + temperature = dhtDevice.temperature * (9 / 5) + 32 + humidity = dhtDevice.humidity + print("Temp: {:.1f} F Humidity: {}% ".format(temperature, humidity)) + + except RuntimeError as error: + print(error.args) + + time.sleep(2.0) diff --git a/examples/dhttoleddisplay.py b/examples/dht_to_led_display.py similarity index 94% rename from examples/dhttoleddisplay.py rename to examples/dht_to_led_display.py index b3b7335..de7bed1 100644 --- a/examples/dhttoleddisplay.py +++ b/examples/dht_to_led_display.py @@ -25,7 +25,7 @@ while True: try: # show the values to the serial port - temperature = dhtDevice.temperature*9/5+32 + temperature = dhtDevice.temperature * (9 / 5) + 32 humidity = dhtDevice.humidity #print("Temp: {:.1f} F Humidity: {}% ".format(temperature, humidity))