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 feaf0b9..1e730d8 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,17 +16,19 @@ 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 pytest + - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme pytest script: - - py.tests + - py.test - pylint adafruit_motor/*.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - ([[ ! -d "tests" ]] || pylint --disable=missing-docstring tests/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-motor --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html diff --git a/README.rst b/README.rst index eacc8da..30b08cd 100644 --- a/README.rst +++ b/README.rst @@ -10,6 +10,10 @@ Introduction :target: https://discord.gg/nBQh6qu :alt: Discord +.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_Motor.svg?branch=master + :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_Motor + :alt: Build Status + This helper library provides higher level objects to control motors and servos based on one or more PWM outputs. @@ -27,14 +31,6 @@ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading `the Adafruit library and driver bundle `_. -API Reference -============= - -.. toctree:: - :maxdepth: 2 - - api - Contributing ============ @@ -65,3 +61,27 @@ Then run the build: .. code-block:: shell circuitpython-build-bundles --filename_prefix adafruit-circuitpython-motor --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. + diff --git a/adafruit_motor/stepper.py b/adafruit_motor/stepper.py index 9d457a9..48eb3d1 100644 --- a/adafruit_motor/stepper.py +++ b/adafruit_motor/stepper.py @@ -60,14 +60,14 @@ class StepperMotor: """A bipolar stepper motor or four coil unipolar motor. - :param ~pulseio.PWMOut ain1: `pulseio.PWMOut`-compatible output connected to the driver for the first - coil (unipolar) or first input to first coil (bipolar). - :param ~pulseio.PWMOut ain2: `pulseio.PWMOut`-compatible output connected to the driver for the third - coil (unipolar) or second input to first coil (bipolar). - :param ~pulseio.PWMOut bin1: `pulseio.PWMOut`-compatible output connected to the driver for the second - coil (unipolar) or second input to second coil (bipolar). - :param ~pulseio.PWMOut bin2: `pulseio.PWMOut`-compatible output connected to the driver for the fourth - coil (unipolar) or second input to second coil (bipolar). + :param ~pulseio.PWMOut ain1: `pulseio.PWMOut`-compatible output connected to the driver for + the first coil (unipolar) or first input to first coil (bipolar). + :param ~pulseio.PWMOut ain2: `pulseio.PWMOut`-compatible output connected to the driver for + the third coil (unipolar) or second input to first coil (bipolar). + :param ~pulseio.PWMOut bin1: `pulseio.PWMOut`-compatible output connected to the driver for + the second coil (unipolar) or second input to second coil (bipolar). + :param ~pulseio.PWMOut bin2: `pulseio.PWMOut`-compatible output connected to the driver for + the fourth coil (unipolar) or second input to second coil (bipolar). :param int microsteps: Number of microsteps between full steps. Must be at least 2 and even. """ def __init__(self, ain1, ain2, bin1, bin2, *, microsteps=16): 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 58c313b..781fa8d 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 motor 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', '.env'] +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 = 'AdafruitMotorLibrarydoc' diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000..6aea257 --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,20 @@ +Simple tests +------------- + +Ensure your device works with this simple test. + +.. literalinclude:: ../examples/dc_motor.py + :caption: examples/dc_motor.py + :linenos: + +.. literalinclude:: ../examples/stepper_motor.py + :caption: examples/stepper_motor.py + :linenos: + +.. literalinclude:: ../examples/servo_sweep.py + :caption: examples/servo_sweep.py + :linenos: + +.. literalinclude:: ../examples/continuous_servo.py + :caption: examples/continuous_servo.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..2715ab8 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,45 @@ +.. 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 + +.. 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`