Skip to content

Commit 78d75a7

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 658dbf6 commit 78d75a7

File tree

1 file changed

+4
-22
lines changed

1 file changed

+4
-22
lines changed

README.rst

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -69,28 +69,10 @@ Contributions are welcome! Please read our `Code of Conduct
6969
<https://github.com/adafruit/Adafruit_CircuitPython_GC_IOT_CORE/blob/master/CODE_OF_CONDUCT.md>`_
7070
before contributing to help this project stay welcoming.
7171

72-
Sphinx documentation
73-
-----------------------
74-
75-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
76-
install dependencies (feel free to reuse the virtual environment from above):
77-
78-
.. code-block:: shell
79-
80-
python3 -m venv .env
81-
source .env/bin/activate
82-
pip install Sphinx sphinx-rtd-theme
83-
84-
Now, once you have the virtual environment activated:
85-
86-
.. code-block:: shell
87-
88-
cd docs
89-
sphinx-build -E -W -b html . _build/html
72+
Documentation
73+
=============
9074

91-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
92-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
93-
locally verify it will pass.
75+
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
9476

9577
License
9678
=======
@@ -102,4 +84,4 @@ CircuitPython and the CircuitPython API.
10284
We've added examples for using this library to transmit board telemetry data along
10385
with sensor data to Google's Cloud Platform.
10486

105-
This open source code is licensed under the Apache license (see LICENSE) for details.
87+
This open source code is licensed under the Apache license (see LICENSE) for details.

0 commit comments

Comments
 (0)