Updated Docs

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 144be0833b1c3f92762b0182b58182a2c03840d2..cb39be2808dba303cf57f47ff982fbb048949452 100644 (file)
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -45,7 +45,6 @@ jobs:
     - name: PyLint
       run: |
         pylint $( find . -path './*io.py' )
     - name: PyLint
       run: |
         pylint $( find . -path './*io.py' )

-        ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" ))

     - name: Build docs
       working-directory: docs
       run: sphinx-build -E -W -b html . _build/html
     - name: Build docs
       working-directory: docs
       run: sphinx-build -E -W -b html . _build/html

diff --git a/README.rst b/README.rst
index 5ce0090bfcfccb4c14367f2b283594da16fea1b9..dbaa736f13a76436958f4d125cd2143f9894992e 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,7 +1,7 @@
 Introduction
 ============
 
 Introduction
 ============
 

-.. image:: https://readthedocs.org/projects/adafruit-blinka-circuitpython-displayio/badge/?version=latest
+.. image:: https://readthedocs.org/projects/adafruit-blinka-blinka-displayio/badge/?version=latest

     :target: https://circuitpython.readthedocs.io/projects/displayio/en/latest/
     :alt: Documentation Status
 
     :target: https://circuitpython.readthedocs.io/projects/displayio/en/latest/
     :alt: Documentation Status
 


@@ -24,32 +24,23 @@ Dependencies
 =============
 This driver depends on:
 
 =============
 This driver depends on:
 

-* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
-
-Please ensure all dependencies are available on the CircuitPython filesystem.
-This is easily achieved by downloading
-`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.
+* `Adafruit Blinka <https://github.com/adafruit/Adafruit_Blinka>`_

 
 Installing from PyPI
 =====================
 
 Installing from PyPI
 =====================

-.. note:: This library is not available on PyPI yet. Install documentation is included
-   as a standard element. Stay tuned for PyPI availability!
-
-.. todo:: Remove the above note if PyPI version is/will be available at time of release.
-   If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.

 
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
 
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from

-PyPI <https://pypi.org/project/adafruit-circuitpython-displayio/>`_. To install for current user:
+PyPI <https://pypi.org/project/adafruit-blinka-displayio/>`_. To install for current user:

 
 .. code-block:: shell
 
 
 .. code-block:: shell
 

-    pip3 install adafruit-circuitpython-displayio
+    pip3 install adafruit-blinka-displayio

 
 To install system-wide (this may be required in some cases):
 
 .. code-block:: shell
 
 
 To install system-wide (this may be required in some cases):
 
 .. code-block:: shell
 

-    sudo pip3 install adafruit-circuitpython-displayio
+    sudo pip3 install adafruit-blinka-displayio

 
 To install in a virtual environment in your current project:
 
 
 To install in a virtual environment in your current project:
 


@@ -58,12 +49,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
     mkdir project-name && cd project-name
     python3 -m venv .env
     source .env/bin/activate

-    pip3 install adafruit-circuitpython-displayio
-
-Usage Example
-=============
-
-.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
+    pip3 install adafruit-blinka-displayio

 
 Contributing
 ============
 
 Contributing
 ============


@@ -75,4 +61,4 @@ before contributing to help this project stay welcoming.
 Documentation
 =============
 
 Documentation
 =============
 

-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>`_.
+For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-blinka-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

diff --git a/docs/api.rst b/docs/api.rst
index d36e90d75d3a8b001207d779aa3559c80696c91b..2fa7117ec3132df76a32fd1c766b45f49c387c42 100644 (file)
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -4,5 +4,11 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 

-.. automodule:: adafruit_blinka_displayio
+.. automodule:: displayio
+   :members:
+
+.. automodule:: fontio
+   :members:
+
+.. automodule:: terminalio

    :members:
    :members:

diff --git a/docs/examples.rst b/docs/examples.rst
deleted file mode 100644 (file)
index f1a1ea2..0000000
--- a/docs/examples.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-Simple test
-------------
-
-Ensure your device works with this simple test.
-
-.. literalinclude:: ../examples/displayio_simpletest.py
-    :caption: examples/displayio_simpletest.py
-    :linenos:

diff --git a/docs/index.rst b/docs/index.rst
index f4e95fc162e36dff7b25a66f085c9b3834044677..26f853ae169c64496a1efbfd7d87cc79d1ac1109 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,11 +9,6 @@ Table of Contents
 
     self
 
 
     self
 

-.. toctree::
-    :caption: Examples
-
-    examples
-

 .. toctree::
     :caption: API Reference
     :maxdepth: 3
 .. toctree::
     :caption: API Reference
     :maxdepth: 3


@@ -23,15 +18,9 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
 .. toctree::
     :caption: Tutorials
 

-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-

 .. toctree::
     :caption: Related Products
 
 .. toctree::
     :caption: Related Products
 

-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-

 .. toctree::
     :caption: Other Links
 
 .. toctree::
     :caption: Other Links
 

diff --git a/examples/displayio_simpletest.py b/examples/displayio_simpletest.py
deleted file mode 100644 (file)
index e69de29..0000000

diff --git a/setup.py b/setup.py
index 4d317229d658348d64ffc613805571f901807318..9c2d8f3d1082a9d0cf209bf8cfe77bc299eb9698 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -18,14 +18,14 @@ with open(path.join(here, "README.rst"), encoding="utf-8") as f:
     long_description = f.read()
 
 setup(
     long_description = f.read()
 
 setup(

-    name="adafruit-circuitpython-displayio",
+    name="adafruit-blinka-displayio",

     use_scm_version=True,
     setup_requires=["setuptools_scm"],
     description="displayio for Blinka",
     long_description=long_description,
     long_description_content_type="text/x-rst",
     # The project's main homepage.
     use_scm_version=True,
     setup_requires=["setuptools_scm"],
     description="displayio for Blinka",
     long_description=long_description,
     long_description_content_type="text/x-rst",
     # The project's main homepage.

-    url="https://github.com/adafruit/Adafruit_CircuitPython_displayio",
+    url="https://github.com/adafruit/Adafruit_Blinka_Displayio",

     # Author details
     author="Adafruit Industries",
     author_email="circuitpython@adafruit.com",
     # Author details
     author="Adafruit Industries",
     author_email="circuitpython@adafruit.com",


@@ -47,7 +47,5 @@ setup(
     keywords="adafruit blinka circuitpython micropython displayio lcd tft display pitft",
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
     keywords="adafruit blinka circuitpython micropython displayio lcd tft display pitft",
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().

-    # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
-    #       CHANGE `py_modules=['...']` TO `packages=['...']`
-    py_modules=["adafruit_blinka_displayio"],
+    py_modules=["displayio", "fontio", "terminalio"],

 )
 )