Skip to content

Commit 422dbea

Browse files
authored
Merge pull request #10 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 42a4f4e + 54a3ae9 commit 422dbea

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

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

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