Skip to content

Commit e21d84c

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

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

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

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