Skip to content

Commit 8210578

Browse files
authored
Merge pull request #11 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 6301a2c + bc5daa3 commit 8210578

File tree

1 file changed

+3
-48
lines changed

1 file changed

+3
-48
lines changed

README.rst

Lines changed: 3 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -70,52 +70,7 @@ Contributions are welcome! Please read our `Code of Conduct
7070
<https://github.com/adafruit/Adafruit_CircuitPython_ST7789/blob/master/CODE_OF_CONDUCT.md>`_
7171
before contributing to help this project stay welcoming.
7272

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

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