Skip to content

Commit 0a902d6

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent ecb4b4f commit 0a902d6

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

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

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