Skip to content

Commit 7045072

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

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

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

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