From a26521b67f3936ff008fed6b3d3c5e7dd40bee24 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 17 Oct 2019 14:58:45 -0400 Subject: [PATCH 1/4] Removed building locally section --- README.rst | 50 -------------------------------------------------- 1 file changed, 50 deletions(-) diff --git a/README.rst b/README.rst index ab42fc8..31d0cc5 100644 --- a/README.rst +++ b/README.rst @@ -65,53 +65,3 @@ Contributing Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. - -Building locally -================ - -Zip release files ------------------ - -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-esp32spi --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. From 51c04e3d531862945800255eb61bcff939912510 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 17 Oct 2019 17:39:50 -0400 Subject: [PATCH 2/4] Added link to sphinx section in learn guide --- README.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.rst b/README.rst index 31d0cc5..08dacc0 100644 --- a/README.rst +++ b/README.rst @@ -65,3 +65,5 @@ Contributing Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. + +For information on building library documentation, please check out `this guide`_. From a3d1f6570924d5895ea4c01b2849d532e878b323 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 17 Oct 2019 17:41:33 -0400 Subject: [PATCH 3/4] Fixed link --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 08dacc0..4d727e1 100644 --- a/README.rst +++ b/README.rst @@ -66,4 +66,4 @@ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. -For information on building library documentation, please check out `this guide`_. +For information on building library documentation, please check out `this guide `_. From 136186033f7658618d3ba1e5f05a75eb77808e6a Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 17 Oct 2019 17:45:15 -0400 Subject: [PATCH 4/4] Added documentation heading --- README.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.rst b/README.rst index 4d727e1..71ade9a 100644 --- a/README.rst +++ b/README.rst @@ -66,4 +66,7 @@ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. +Documentation +============= + For information on building library documentation, please check out `this guide `_.