Skip to content

Commit 131378d

Browse files
authored
Merge pull request #4 from dherrada/patch-1
Removed building locally section from README, replaced with documenta…
2 parents cceac64 + 1aa52e6 commit 131378d

File tree

1 file changed

+4
-22
lines changed

1 file changed

+4
-22
lines changed

README.rst

+4-22
Original file line numberDiff line numberDiff line change
@@ -68,28 +68,10 @@ Contributions are welcome! Please read our `Code of Conduct
6868
<https://github.com/adafruit/Adafruit_CircuitPython_ATECC/blob/master/CODE_OF_CONDUCT.md>`_
6969
before contributing to help this project stay welcoming.
7070

71-
Sphinx documentation
72-
-----------------------
73-
74-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
75-
install dependencies (feel free to reuse the virtual environment from above):
76-
77-
.. code-block:: shell
78-
79-
python3 -m venv .env
80-
source .env/bin/activate
81-
pip install Sphinx sphinx-rtd-theme
82-
83-
Now, once you have the virtual environment activated:
84-
85-
.. code-block:: shell
86-
87-
cd docs
88-
sphinx-build -E -W -b html . _build/html
71+
Documentation
72+
=============
8973

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

9476
License
9577
========
@@ -98,4 +80,4 @@ This library was written by Arduino SA. We've converted it to work with Adafruit
9880
changes for it to work with CircuitPython devices and single-board linux computers running CircuitPython libraries. We've
9981
added examples to demonstrate using the nonce, random, monotonic counter and SHA256 security functions within the library.
10082

101-
This open source code is licensed under the LGPL License (see LICENSE for details).
83+
This open source code is licensed under the LGPL License (see LICENSE for details).

0 commit comments

Comments
 (0)