From 78d75a78e3d9a0efa11d0f04bdb9889e4142740e Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 17 Oct 2019 18:39:50 -0400 Subject: [PATCH] Removed building locally section from README, replaced with documentation section --- README.rst | 26 ++++---------------------- 1 file changed, 4 insertions(+), 22 deletions(-) diff --git a/README.rst b/README.rst index 6fb7ed5..0217bce 100644 --- a/README.rst +++ b/README.rst @@ -69,28 +69,10 @@ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. -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 +Documentation +============= -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. +For information on building library documentation, please check out `this guide `_. License ======= @@ -102,4 +84,4 @@ CircuitPython and the CircuitPython API. We've added examples for using this library to transmit board telemetry data along with sensor data to Google's Cloud Platform. -This open source code is licensed under the Apache license (see LICENSE) for details. \ No newline at end of file +This open source code is licensed under the Apache license (see LICENSE) for details.