Skip to content

Commit bda16b6

Browse files
authored
Merge pull request #1 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 7c92f70 + 4dc6749 commit bda16b6

File tree

1 file changed

+3
-48
lines changed

1 file changed

+3
-48
lines changed

README.rst

+3-48
Original file line numberDiff line numberDiff line change
@@ -76,52 +76,7 @@ Contributions are welcome! Please read our `Code of Conduct
7676
<https://github.com/adafruit/Adafruit_CircuitPython_BD3491FS/blob/master/CODE_OF_CONDUCT.md>`_
7777
before contributing to help this project stay welcoming.
7878

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

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