Merge pull request #4 from lesamouraipourpre/docs

jposada202020 · web-flow · commit ad2a86e7000e · 2021-06-03T16:25:06.000-04:00
Updates to Docs
diff --git a/README.rst b/README.rst
@@ -2,8 +2,8 @@ Introduction
 ============
 
 
-.. image:: https://readthedocs.org/projects/circuitpython-displayio_switchround/badge/?version=latest
-    :target: https://circuitpython-displayio_switchround.readthedocs.io/
+.. image:: https://readthedocs.org/projects/circuitpython-displayio-switchround/badge/?version=latest
+    :target: https://circuitpython-displayio-switchround.readthedocs.io/
     :alt: Documentation Status
 
 
@@ -39,8 +39,8 @@ or individual libraries can be installed using
 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-displayio_switchround/>`_.
+On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally
+`from PyPI <https://pypi.org/project/circuitpython-displayio-switchround/>`_.
 To install for current user:
 
 .. code-block:: shell
diff --git a/displayio_switchround.py b/displayio_switchround.py
diff --git a/docs/api.rst b/docs/api.rst
@@ -8,5 +8,3 @@
     :members:
     :member-order: bysource
     :inherited-members:
-
-.. inheritance-diagram:: adafruit_displayio_layout.widgets.switch_round
diff --git a/docs/conf.py b/docs/conf.py
@@ -35,6 +35,10 @@
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3.4", None),
     "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
+    "Layout": (
+        "https://circuitpython.readthedocs.io/projects/displayio-layout/en/latest/",
+        None,
+    ),
 }
 
 # Show the docstring from both the class and its __init__() method.
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,6 +15,11 @@ Table of Contents
 
     examples
 
+.. toctree::
+    :caption: Overview
+
+    overview
+
 .. toctree::
     :caption: API Reference
     :maxdepth: 3
diff --git a/docs/overview.rst b/docs/overview.rst
diff --git a/docs/overview.rst.license b/docs/overview.rst.license
@@ -0,0 +1,4 @@
+SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+SPDX-FileCopyrightText: Copyright (c) 2021 Kevin Matocha for circuitpython
+
+SPDX-License-Identifier: MIT
