Skip to content

Commit 2a8ac66

Browse files
authored
Merge pull request #13 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 8a1c8b6 + abb420d commit 2a8ac66

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

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

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