Skip to content

Commit 0e82a6e

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 447c961 commit 0e82a6e

File tree

1 file changed

+3
-45
lines changed

1 file changed

+3
-45
lines changed

README.rst

Lines changed: 3 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -71,49 +71,7 @@ Contributions are welcome! Please read our `Code of Conduct
7171
<https://github.com/adafruit/Adafruit_CircuitPython_MAX21855/blob/master/CODE_OF_CONDUCT.md>`_
7272
before contributing to help this project stay welcoming.
7373

74-
Building locally
75-
================
76-
77-
To build this library locally you'll need to install the
78-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
79-
80-
.. code-block:: shell
81-
82-
python3 -m venv .env
83-
source .env/bin/activate
84-
pip install circuitpython-build-tools
85-
86-
Once installed, make sure you are in the virtual environment:
87-
88-
.. code-block:: shell
89-
90-
source .env/bin/activate
91-
92-
Then run the build:
93-
94-
.. code-block:: shell
95-
96-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-max31855 --library_location .
97-
98-
Sphinx documentation
99-
-----------------------
100-
101-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
102-
install dependencies (feel free to reuse the virtual environment from above):
103-
104-
.. code-block:: shell
105-
106-
python3 -m venv .env
107-
source .env/bin/activate
108-
pip install Sphinx sphinx-rtd-theme
109-
110-
Now, once you have the virtual environment activated:
111-
112-
.. code-block:: shell
113-
114-
cd docs
115-
sphinx-build -E -W -b html . _build/html
74+
Documentation
75+
=============
11676

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