Merge pull request #32 from lesamouraipourpre/requirements

Update the requirements for installation and docs building

Author: ladyada

README.rst

@@ -29,17 +29,17 @@ This is easily achieved by downloading
 Installing from PyPI
 --------------------
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
-PyPI <https://pypi.org/project/adafruit-circuitpython-display_button/>`_. To install for current user:
+PyPI <https://pypi.org/project/adafruit-circuitpython-display-button/>`_. To install for current user:
 
 .. code-block:: shell
 
-    pip3 install adafruit-circuitpython-display_button
+    pip3 install adafruit-circuitpython-display-button
 
 To install system-wide (this may be required in some cases):
 
 .. code-block:: shell
 
-    sudo pip3 install adafruit-circuitpython-display_button
+    sudo pip3 install adafruit-circuitpython-display-button
 
 To install in a virtual environment in your current project:
 
@@ -48,7 +48,7 @@ To install in a virtual environment in your current project:
     mkdir project-name && cd project-name
     python3 -m venv .env
     source .env/bin/activate
-    pip3 install adafruit-circuitpython-display_button
+    pip3 install adafruit-circuitpython-display-button
 
 Usage Example
 =============

docs/conf.py

@@ -25,7 +25,7 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-autodoc_mock_imports = ["displayio", "adafruit_display_text", "adafruit_display_shapes"]
+autodoc_mock_imports = ["displayio"]
 
 
 intersphinx_mapping = {

requirements.txt

@@ -4,3 +4,5 @@
 
 Adafruit-Blinka
 adafruit-blinka-displayio
+adafruit-circuitpython-display-text
+adafruit-circuitpython-display-shapes

setup.py

@@ -33,7 +33,12 @@
     # Author details
     author="Adafruit Industries",
     author_email="[email protected]",
-    install_requires=["Adafruit-Blinka", "adafruit-blinka-displayio"],
+    install_requires=[
+        "Adafruit-Blinka",
+        "adafruit-blinka-displayio",
+        "adafruit-circuitpython-display-text",
+        "adafruit-circuitpython-display-shapes",
+    ],
     # Choose your license
     license="MIT",
     # See https://pypi.python.org/pypi?%3Aaction=list_classifiers