Skip to content

Commit 20a56e2

Browse files
authored
Merge pull request adafruit#7 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 17f2a0c + 1b92310 commit 20a56e2

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

65-
Building locally
66-
================
67-
68-
Zip release files
69-
-----------------
70-
71-
To build this library locally you'll need to install the
72-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
73-
74-
.. code-block:: shell
75-
76-
python3 -m venv .env
77-
source .env/bin/activate
78-
pip install circuitpython-build-tools
79-
80-
Once installed, make sure you are in the virtual environment:
81-
82-
.. code-block:: shell
83-
84-
source .env/bin/activate
85-
86-
Then run the build:
87-
88-
.. code-block:: shell
89-
90-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-sharpmemorydisplay --library_location .
91-
92-
Sphinx documentation
93-
-----------------------
94-
95-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
96-
install dependencies (feel free to reuse the virtual environment from above):
97-
98-
.. code-block:: shell
99-
100-
python3 -m venv .env
101-
source .env/bin/activate
102-
pip install Sphinx sphinx-rtd-theme
103-
104-
Now, once you have the virtual environment activated:
105-
106-
.. code-block:: shell
107-
108-
cd docs
109-
sphinx-build -E -W -b html . _build/html
65+
Documentation
66+
=============
11067

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