Skip to content

Commit 8833bb6

Browse files
authored
Merge pull request #7 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents b446f14 + c5e4599 commit 8833bb6

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

64-
Building Locally
65-
================
64+
Documentation
65+
=============
6666

67-
Zip release files
68-
-----------------
69-
70-
To build this library locally you'll need to install the
71-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
72-
73-
.. code-block:: shell
74-
75-
python3 -m venv .env
76-
source .env/bin/activate
77-
pip install circuitpython-build-tools
78-
79-
Once installed, make sure you are in the virtual environment:
80-
81-
.. code-block:: shell
82-
83-
source .env/bin/activate
84-
85-
Then run the build:
86-
87-
.. code-block:: shell
88-
89-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-as726x --library_location .
90-
91-
Sphinx Documentation
92-
--------------------
93-
94-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
95-
install dependencies (feel free to reuse the virtual environment from above):
96-
97-
.. code-block:: shell
98-
99-
python3 -m venv .env
100-
source .env/bin/activate
101-
pip install Sphinx sphinx-rtd-theme
102-
103-
Now, once you have the virtual environment activated:
104-
105-
.. code-block:: shell
106-
107-
cd docs
108-
sphinx-build -E -W -b html . _build/html
109-
110-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
111-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
112-
locally verify it will pass.
67+
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)