Skip to content

Commit 6171a38

Browse files
authored
Merge pull request #16 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents b96f0fe + 56f7065 commit 6171a38

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

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

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