Skip to content

Commit 54ef557

Browse files
authored
Merge pull request #14 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 72b4b7b + be30ec1 commit 54ef557

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
@@ -126,49 +126,7 @@ Contributions are welcome! Please read our `Code of Conduct
126126
<https://github.com/adafruit/Adafruit_CircuitPython_DS1307/blob/master/CODE_OF_CONDUCT.md>`_
127127
before contributing to help this project stay welcoming.
128128

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

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