Skip to content

Commit 8161762

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent a71183e commit 8161762

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

58-
Building locally
59-
================
60-
61-
To build this library locally you'll need to install the
62-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
63-
64-
.. code-block:: shell
65-
66-
python3 -m venv .env
67-
source .env/bin/activate
68-
pip install circuitpython-build-tools
69-
70-
Once installed, make sure you are in the virtual environment:
71-
72-
.. code-block:: shell
73-
74-
source .env/bin/activate
75-
76-
Then run the build:
77-
78-
.. code-block:: shell
79-
80-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-focaltouch --library_location .
81-
82-
Sphinx documentation
83-
-----------------------
84-
85-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
86-
install dependencies (feel free to reuse the virtual environment from above):
87-
88-
.. code-block:: shell
89-
90-
python3 -m venv .env
91-
source .env/bin/activate
92-
pip install Sphinx sphinx-rtd-theme
93-
94-
Now, once you have the virtual environment activated:
95-
96-
.. code-block:: shell
97-
98-
cd docs
99-
sphinx-build -E -W -b html . _build/html
58+
Documentation
59+
=============
10060

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