diff --git a/readthedocs.yml b/.readthedocs.yml similarity index 100% rename from readthedocs.yml rename to .readthedocs.yml diff --git a/.travis.yml b/.travis.yml index 18eb258..bde19a9 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_ads1x15/*.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ads1x15 --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html diff --git a/README.rst b/README.rst index 18b1693..c3e69f1 100644 --- a/README.rst +++ b/README.rst @@ -6,9 +6,9 @@ Introduction :target: https://circuitpython.readthedocs.io/projects/CircuitPython_ADS1x15/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 Support for the ADS1x15 series of analog-to-digital converters. Available in 12-bit (ADS1015) and 16-bit (ADS1115) versions. @@ -65,10 +65,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-ads1x15 --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/adafruit_ads1x15/differential.py b/adafruit_ads1x15/differential.py index 1e1f9be..9a4a148 100644 --- a/adafruit_ads1x15/differential.py +++ b/adafruit_ads1x15/differential.py @@ -46,10 +46,10 @@ def __getitem__(self, key): def read_adc_difference(self, differential, gain=1, data_rate=None): """Read the difference between two ADC channels and return the ADC value as a signed integer result. Differential must be one of: - - 0 = Channel 0 minus channel 1 - - 1 = Channel 0 minus channel 3 - - 2 = Channel 1 minus channel 3 - - 3 = Channel 2 minus channel 3 + - 0 = Channel 0 minus channel 1 + - 1 = Channel 0 minus channel 3 + - 2 = Channel 1 minus channel 3 + - 3 = Channel 2 minus channel 3 """ assert 0 <= differential <= 3, 'Differential must be a value within 0-3!' # Perform a single shot read using the provided differential value @@ -59,10 +59,10 @@ def read_adc_difference(self, differential, gain=1, data_rate=None): def read_volts_difference(self, differential, gain=1, data_rate=None): """Read the difference between two ADC channels and return the voltage value as a floating point result. Differential must be one of: - - 0 = Channel 0 minus channel 1 - - 1 = Channel 0 minus channel 3 - - 2 = Channel 1 minus channel 3 - - 3 = Channel 2 minus channel 3 + - 0 = Channel 0 minus channel 1 + - 1 = Channel 0 minus channel 3 + - 2 = Channel 1 minus channel 3 + - 3 = Channel 2 minus channel 3 """ assert 0 <= differential <= 3, 'Differential must be a value within 0-3!' raw = self.read_adc_difference(differential, gain, data_rate) @@ -72,10 +72,10 @@ def read_volts_difference(self, differential, gain=1, data_rate=None): def start_adc_difference(self, differential, gain=1, data_rate=None): """Start continuous ADC conversions between two ADC channels. Differential must be one of: - - 0 = Channel 0 minus channel 1 - - 1 = Channel 0 minus channel 3 - - 2 = Channel 1 minus channel 3 - - 3 = Channel 2 minus channel 3 + - 0 = Channel 0 minus channel 1 + - 1 = Channel 0 minus channel 3 + - 2 = Channel 1 minus channel 3 + - 3 = Channel 2 minus channel 3 Will return an initial conversion result, then call the get_last_result() function continuously to read the most recent conversion result. Call stop_adc() to stop conversions. diff --git a/api.rst b/api.rst deleted file mode 100644 index 66ca1db..0000000 --- a/api.rst +++ /dev/null @@ -1,11 +0,0 @@ - -.. If you created a package, create one automodule per module in the package. - -.. automodule:: adafruit_ads1x15 - :members: - -.. automodule:: differential - :members: - -.. automodule:: single_ended - :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..0583855 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,11 @@ + +.. If you created a package, create one automodule per module in the package. + +.. automodule:: adafruit_ads1x15.adafruit_ads1x15 + :members: + +.. automodule:: adafruit_ads1x15.differential + :members: + +.. automodule:: adafruit_ads1x15.single_ended + :members: \ No newline at end of file diff --git a/conf.py b/docs/conf.py similarity index 91% rename from conf.py rename to docs/conf.py index 7fd8951..c06acf5 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_ADS1X15 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 = 'AdafruitCIRCUITPYTHON_ADS1X15Librarydoc' diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000..fb6f01b --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,12 @@ +Simple test +------------ + +Ensure your device works with this simple test. + +.. literalinclude:: ../examples/ads1115_single_ended_simpletest.py + :caption: examples/ads1115_single_ended_simpletest.py + :linenos: + +.. literalinclude:: ../examples/ads1115_differential_simpletest.py + :caption: examples/ads1115_differential_simpletest.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..2f7254f --- /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 + + ADS1015 12-Bit ADC - 4 Channel with Programmable Gain Amplifier + + ADS1115 16-Bit ADC - 4 Channel with Programmable Gain Amplifier + +.. 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/ads1115_differential.py b/examples/ads1115_differential_simpletest.py similarity index 100% rename from examples/ads1115_differential.py rename to examples/ads1115_differential_simpletest.py diff --git a/examples/ads1115_single_ended.py b/examples/ads1115_single_ended_simpletest.py similarity index 100% rename from examples/ads1115_single_ended.py rename to examples/ads1115_single_ended_simpletest.py