Skip to content

Commit b79d4c5

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

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

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

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