Skip to content

Commit 0e840ad

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 06ba88d commit 0e840ad

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

42-
Building locally
43-
================
44-
45-
Zip release files
46-
-----------------
47-
48-
To build this library locally you'll need to install the
49-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
50-
51-
.. code-block:: shell
52-
53-
python3 -m venv .env
54-
source .env/bin/activate
55-
pip install circuitpython-build-tools
56-
57-
Once installed, make sure you are in the virtual environment:
58-
59-
.. code-block:: shell
60-
61-
source .env/bin/activate
62-
63-
Then run the build:
64-
65-
.. code-block:: shell
66-
67-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-stmpe610 --library_location .
68-
69-
Sphinx documentation
70-
-----------------------
71-
72-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
73-
install dependencies (feel free to reuse the virtual environment from above):
74-
75-
.. code-block:: shell
76-
77-
python3 -m venv .env
78-
source .env/bin/activate
79-
pip install Sphinx sphinx-rtd-theme
80-
81-
Now, once you have the virtual environment activated:
82-
83-
.. code-block:: shell
84-
85-
cd docs
86-
sphinx-build -E -W -b html . _build/html
42+
Documentation
43+
=============
8744

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