Skip to content

Commit 8fff690

Browse files
authored
Merge pull request #23 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 814bda6 + f405ff1 commit 8fff690

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

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

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