Skip to content

Commit ea24bc4

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 59dd882 commit ea24bc4

File tree

1 file changed

+3
-45
lines changed

1 file changed

+3
-45
lines changed

README.rst

Lines changed: 3 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -38,49 +38,7 @@ Contributions are welcome! Please read our `Code of Conduct
3838
<https://github.com/adafruit/Adafruit_CircuitPython_MAX9744/blob/master/CODE_OF_CONDUCT.md>`_
3939
before contributing to help this project stay welcoming.
4040

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

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