Skip to content

Commit 68daeb5

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent f4608f0 commit 68daeb5

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

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

141-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
142-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
143-
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)