Skip to content

Commit 1ba1d23

Browse files
authored
Merge pull request #42 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 2b1dbc2 + c17d80a commit 1ba1d23

File tree

1 file changed

+3
-45
lines changed

1 file changed

+3
-45
lines changed

README.rst

+3-45
Original file line numberDiff line numberDiff line change
@@ -117,49 +117,7 @@ Contributions are welcome! Please read our `Code of Conduct
117117
<https://github.com/adafruit/Adafruit_CircuitPython_CharLCD/blob/master/CODE_OF_CONDUCT.md>`_ before contributing to help this project stay welcoming.
118118

119119

120-
Building locally
121-
================
122-
123-
To build this library locally you'll need to install the
124-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
125-
126-
.. code-block:: shell
127-
128-
python3 -m venv .env
129-
source .env/bin/activate
130-
pip install circuitpython-build-tools
131-
132-
Once installed, make sure you are in the virtual environment:
133-
134-
.. code-block:: shell
135-
136-
source .env/bin/activate
137-
138-
Then run the build:
139-
140-
.. code-block:: shell
141-
142-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-charlcd --library_location .
143-
144-
Sphinx documentation
145-
-----------------------
146-
147-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
148-
install dependencies (feel free to reuse the virtual environment from above):
149-
150-
.. code-block:: shell
151-
152-
python3 -m venv .env
153-
source .env/bin/activate
154-
pip install Sphinx sphinx-rtd-theme
155-
156-
Now, once you have the virtual environment activated:
157-
158-
.. code-block:: shell
159-
160-
cd docs
161-
sphinx-build -E -W -b html . _build/html
120+
Documentation
121+
=============
162122

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