Skip to content

Commit d7def36

Browse files
authored
Merge pull request #4 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 2682832 + 62f8b0f commit d7def36

File tree

1 file changed

+3
-48
lines changed

1 file changed

+3
-48
lines changed

README.rst

+3-48
Original file line numberDiff line numberDiff line change
@@ -95,52 +95,7 @@ Contributions are welcome! Please read our `Code of Conduct
9595
<https://github.com/adafruit/Adafruit_CircuitPython_DymoScale/blob/master/CODE_OF_CONDUCT.md>`_
9696
before contributing to help this project stay welcoming.
9797

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

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