Skip to content

Updates to Docs #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 3, 2021
Merged

Updates to Docs #4

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6aacbea
Update the PyPI and readthedocs links in README.rst
lesamouraipourpre May 27, 2021
25c4dee
Add cross-reference links to adafruit_displayio_layout
lesamouraipourpre May 27, 2021
86c3408
Correct the Inheritance diagrams
lesamouraipourpre Jun 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -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
Expand Down
411 changes: 53 additions & 358 deletions displayio_switchround.py
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 0 additions & 2 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,3 @@
:members:
:member-order: bysource
:inherited-members:

.. inheritance-diagram:: adafruit_displayio_layout.widgets.switch_round
4 changes: 4 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 5 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ Table of Contents

examples

.. toctree::
:caption: Overview

overview

.. toctree::
:caption: API Reference
:maxdepth: 3
Expand Down
340 changes: 340 additions & 0 deletions docs/overview.rst
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions docs/overview.rst.license
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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