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 702013f..ec89a1d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,16 +16,17 @@ deploy: provider: releases api_key: $GITHUB_TOKEN file_glob: true - file: bundles/* + file: $TRAVIS_BUILD_DIR/bundles/* skip_cleanup: true overwrite: true on: tags: true install: - - pip install pylint circuitpython-build-tools + - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme script: - pylint adafruit_mcp4725.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-mcp4725 --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html \ No newline at end of file diff --git a/README.rst b/README.rst index ffee624..3703bef 100644 --- a/README.rst +++ b/README.rst @@ -10,10 +10,6 @@ Introduction :target: https://discord.gg/nBQh6qu :alt: Discord -.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_MCP4725.svg?branch=master - :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_MCP4725 - :alt: Build Status - CircuitPython module for the MCP4725 digital to analog converter. Dependencies @@ -29,15 +25,7 @@ This is easily achieved by downloading Usage Example ============= -See examples/simpletest.py for a demo of the usage. - -API Reference -============= - -.. toctree:: - :maxdepth: 2 - - api +See examples/max4725_simpletest.py for a demo of the usage. Contributing ============ @@ -69,3 +57,26 @@ Then run the build: .. code-block:: shell circuitpython-build-bundles --filename_prefix adafruit-circuitpython-mcp4725 --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 + +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. \ No newline at end of file diff --git a/adafruit_mcp4725.py b/adafruit_mcp4725.py index a19fc8e..090538d 100644 --- a/adafruit_mcp4725.py +++ b/adafruit_mcp4725.py @@ -24,9 +24,22 @@ ======================================================== CircuitPython module for the MCP4725 digital to analog converter. See -examples/simpletest.py for a demo of the usage. +examples/mcp4725_simpletest.py for a demo of the usage. * Author(s): Tony DiCola + +Implementation Notes +-------------------- + +**Hardware:** + +* Adafruit `MCP4725 Breakout Board - 12-Bit DAC w/I2C Interface + `_ (Product ID: 935) + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the ESP8622 and M0-based boards: + https://github.com/adafruit/circuitpython/releases """ from micropython import const @@ -40,12 +53,13 @@ class MCP4725: - """MCP4725 12-bit digital to analog converter. This class has a similar - interface as the CircuitPython AnalogOut class and can be used in place - of that module. + """ + MCP4725 12-bit digital to analog converter. This class has a similar + interface as the CircuitPython AnalogOut class and can be used in place + of that module. - :param ~busio.I2C i2c: The I2C bus. - :param int address: The address of the device if set differently from the default. + :param ~busio.I2C i2c: The I2C bus. + :param int address: The address of the device if set differently from the default. """ @@ -97,12 +111,13 @@ def _read(self): @property def value(self): - """The DAC value as a 16-bit unsigned value compatible with the + """ + The DAC value as a 16-bit unsigned value compatible with the :py:class:`~analogio.AnalogOut` class. Note that the MCP4725 is still just a 12-bit device so quantization will occur. If you'd - like to instead deal with the raw 12-bit value use the raw_value property, or the - normalized_value property to deal with a 0...1 float value. + like to instead deal with the raw 12-bit value use the ``raw_value`` property, or the + ``normalized_value`` property to deal with a 0...1 float value. """ raw_value = self._read() # Scale up to 16-bit range. 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/api.rst b/docs/api.rst similarity index 100% rename from api.rst rename to docs/api.rst diff --git a/conf.py b/docs/conf.py similarity index 90% rename from conf.py rename to docs/conf.py index 2549a10..1ed7aaa 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 MCP4725 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 = 'AdafruitMcp4725Librarydoc' diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000..9fb1c1e --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,8 @@ +Simple test +------------ + +Ensure your device works with this simple test. + +.. literalinclude:: ../examples/mcp4725_simpletest.py + :caption: examples/mcp4725_simpletest.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..e7b64b4 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,47 @@ +.. 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 + + Adafruit MCP4725 Breakout Board - 12-Bit DAC w/I2C Interface + +.. 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/simpletest.py b/examples/mcp4725_simpletest.py similarity index 100% rename from examples/simpletest.py rename to examples/mcp4725_simpletest.py