Skip to content

Commit b70d3c4

Browse files
authored
Merge pull request #14 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents ea8fc57 + 9be0053 commit b70d3c4

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

81-
Building locally
82-
================
83-
84-
To build this library locally you'll need to install the
85-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
86-
87-
.. code-block:: shell
88-
89-
python3 -m venv .env
90-
source .env/bin/activate
91-
pip install circuitpython-build-tools
92-
93-
Once installed, make sure you are in the virtual environment:
94-
95-
.. code-block:: shell
96-
97-
source .env/bin/activate
98-
99-
Then run the build:
100-
101-
.. code-block:: shell
102-
103-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-fxos8700 --library_location .
104-
105-
Sphinx documentation
106-
-----------------------
107-
108-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
109-
install dependencies (feel free to reuse the virtual environment from above):
110-
111-
.. code-block:: shell
112-
113-
python3 -m venv .env
114-
source .env/bin/activate
115-
pip install Sphinx sphinx-rtd-theme
116-
117-
Now, once you have the virtual environment activated:
118-
119-
.. code-block:: shell
120-
121-
cd docs
122-
sphinx-build -E -W -b html . _build/html
81+
Documentation
82+
=============
12383

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