Skip to content

Commit 1e088f5

Browse files
authored
Replaced building locally section with documentation section
1 parent 1b79d17 commit 1e088f5

File tree

1 file changed

+3
-46
lines changed

1 file changed

+3
-46
lines changed

README.rst

Lines changed: 3 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -44,50 +44,7 @@ Contributions are welcome! Please read our `Code of Conduct
4444
<https://github.com/adafruit/Adafruit_CircuitPython_BusDevice/blob/master/CODE_OF_CONDUCT.md>`_
4545
before contributing to help this project stay welcoming.
4646

47-
Building locally
48-
================
49-
50-
To build this library locally you'll need to install the
51-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
52-
53-
.. code-block:: shell
54-
55-
python3 -m venv .env
56-
source .env/bin/activate
57-
pip install circuitpython-build-tools
58-
59-
Once installed, make sure you are in the virtual environment:
60-
61-
.. code-block:: shell
62-
63-
source .env/bin/activate
64-
65-
Then run the build:
66-
67-
.. code-block:: shell
68-
69-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-busdevice --library_location .
70-
71-
Sphinx documentation
72-
-----------------------
73-
74-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
75-
install dependencies (feel free to reuse the virtual environment from above):
76-
77-
.. code-block:: shell
78-
79-
python3 -m venv .env
80-
source .env/bin/activate
81-
pip install Sphinx sphinx-rtd-theme
82-
83-
Now, once you have the virtual environment activated:
84-
85-
.. code-block:: shell
86-
87-
cd docs
88-
sphinx-build -E -W -b html . _build/html
89-
90-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
91-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
92-
locally verify it will pass.
47+
Documentation
48+
=============
9349

50+
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)