Skip to content

Commit f7dbc72

Browse files
authored
Merge pull request #7 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 3628658 + 2d84f0b commit f7dbc72

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
@@ -74,52 +74,7 @@ Contributions are welcome! Please read our `Code of Conduct
7474
<https://github.com/adafruit/Adafruit_CircuitPython_ST7735/blob/master/CODE_OF_CONDUCT.md>`_
7575
before contributing to help this project stay welcoming.
7676

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

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