Skip to content

Commit e15077c

Browse files
authored
Merge pull request #6 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents f0918e7 + 8c067a7 commit e15077c

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

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

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