Skip to content

Commit bf5f9be

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 9d781b0 commit bf5f9be

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

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

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