Skip to content

Commit 37d4631

Browse files
authored
Merge pull request #13 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 3d8bb0f + be0b093 commit 37d4631

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

75-
Building locally
76-
================
77-
78-
Zip release files
79-
-----------------
80-
81-
To build this library locally you'll need to install the
82-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
83-
84-
.. code-block:: shell
85-
86-
python3 -m venv .env
87-
source .env/bin/activate
88-
pip install circuitpython-build-tools
89-
90-
Once installed, make sure you are in the virtual environment:
91-
92-
.. code-block:: shell
93-
94-
source .env/bin/activate
95-
96-
Then run the build:
97-
98-
.. code-block:: shell
99-
100-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-miniesptool --library_location .
101-
102-
Sphinx documentation
103-
-----------------------
104-
105-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
106-
install dependencies (feel free to reuse the virtual environment from above):
107-
108-
.. code-block:: shell
109-
110-
python3 -m venv .env
111-
source .env/bin/activate
112-
pip install Sphinx sphinx-rtd-theme
113-
114-
Now, once you have the virtual environment activated:
115-
116-
.. code-block:: shell
117-
118-
cd docs
119-
sphinx-build -E -W -b html . _build/html
75+
Documentation
76+
=============
12077

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