Skip to content

Commit 8d6209b

Browse files
authored
Merge pull request #29 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents cdcd1a5 + 5a1474c commit 8d6209b

File tree

1 file changed

+28
-48
lines changed

1 file changed

+28
-48
lines changed

README.rst

Lines changed: 28 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2727
This is easily achieved by downloading
2828
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
2929

30+
Installing from PyPI
31+
====================
32+
33+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
34+
PyPI <https://pypi.org/project/adafruit-circuitpython-epd/>`_. To install for current user:
35+
36+
.. code-block:: shell
37+
38+
pip3 install adafruit-circuitpython-epd
39+
40+
To install system-wide (this may be required in some cases):
41+
42+
.. code-block:: shell
43+
44+
sudo pip3 install adafruit-circuitpython-epd
45+
46+
To install in a virtual environment in your current project:
47+
48+
.. code-block:: shell
49+
50+
mkdir project-name && cd project-name
51+
python3 -m venv .env
52+
source .env/bin/activate
53+
pip3 install adafruit-circuitpython-epd
54+
3055
Usage Example
3156
=============
3257

@@ -79,52 +104,7 @@ Contributions are welcome! Please read our `Code of Conduct
79104
<https://github.com/adafruit/Adafruit_CircuitPython_EPD/blob/master/CODE_OF_CONDUCT.md>`_
80105
before contributing to help this project stay welcoming.
81106

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

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