Skip to content

Commit e1a3d84

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 607867c commit e1a3d84

File tree

1 file changed

+3
-48
lines changed

1 file changed

+3
-48
lines changed

README.rst

Lines changed: 3 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -83,52 +83,7 @@ Contributions are welcome! Please read our `Code of Conduct
8383
<https://github.com/adafruit/Adafruit_CircuitPython_MLX90393/blob/master/CODE_OF_CONDUCT.md>`_
8484
before contributing to help this project stay welcoming.
8585

86-
Building locally
87-
================
88-
89-
Zip release files
90-
-----------------
91-
92-
To build this library locally you'll need to install the
93-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
94-
95-
.. code-block:: shell
96-
97-
python3 -m venv .env
98-
source .env/bin/activate
99-
pip install circuitpython-build-tools
100-
101-
Once installed, make sure you are in the virtual environment:
102-
103-
.. code-block:: shell
104-
105-
source .env/bin/activate
106-
107-
Then run the build:
108-
109-
.. code-block:: shell
110-
111-
circuitpython-build-bundles --filename_prefix adafruit_circuitpython_mlx90393 --library_location .
112-
113-
Sphinx documentation
114-
-----------------------
115-
116-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
117-
install dependencies (feel free to reuse the virtual environment from above):
118-
119-
.. code-block:: shell
120-
121-
python3 -m venv .env
122-
source .env/bin/activate
123-
pip install Sphinx sphinx-rtd-theme
124-
125-
Now, once you have the virtual environment activated:
126-
127-
.. code-block:: shell
128-
129-
cd docs
130-
sphinx-build -E -W -b html . _build/html
86+
Documentation
87+
=============
13188

132-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
133-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
134-
locally verify it will pass.
89+
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>`_.

0 commit comments

Comments
 (0)