Skip to content

Commit 9f7040c

Browse files
authored
Merge pull request #7 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 8198cb6 + a25d283 commit 9f7040c

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

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

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