From 724b4c63759d72af09e534721ca98634c413e1b7 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 1 Mar 2018 20:44:15 -0600 Subject: [PATCH] updated README --- README.rst | 51 +++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 45 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 493eb27..b1eaf0d 100644 --- a/README.rst +++ b/README.rst @@ -26,7 +26,7 @@ This is easily achieved by downloading Usage Example ============= -See examples/simpletest.py for a demo of the usage. +See examples/max31865_simpletest.py for a demo of the usage. Contributing ============ @@ -35,10 +35,49 @@ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. -API Reference -============= +Building locally +================ -.. toctree:: - :maxdepth: 2 +To build this library locally you'll need to install the +`circuitpython-build-tools `_ package. - api +.. 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-max31865 --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