diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0afe50a..016df26 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: pylint-2.7.1 + rev: v2.11.1 hooks: - id: pylint name: pylint (library code) diff --git a/README.rst b/README.rst index 4a75c77..6187c81 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,22 @@ Introduction ============ +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-typing/badge/?version=latest + :target: https://docs.circuitpython.org/projects/typing/en/latest/ + :alt: Documentation Status + +.. image:: https://img.shields.io/discord/327254708534116352.svg + :target: https://adafru.it/discord + :alt: Discord + +.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Typing/workflows/Build%20CI/badge.svg + :target: https://github.com/adafruit/Adafruit_CircuitPython_Typing/actions + :alt: Build Status + +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + :alt: Code Style: Black + Definitions not in the standard `typing` module that are needed for type annotation of CircuitPython code. diff --git a/docs/examples.rst b/docs/examples.rst index 07edec7..cab7fb6 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -3,6 +3,6 @@ Simple test Ensure your device works with this simple test. -.. literalinclude:: ../examples/circuitpython_typing_simpletest.py - :caption: examples/circuitpython_typing_simpletest.py +.. literalinclude:: ../examples/typing_simpletest.py + :caption: examples/typing_simpletest.py :linenos: diff --git a/examples/circuitpython_typing_simpletest.py b/examples/typing_simpletest.py similarity index 100% rename from examples/circuitpython_typing_simpletest.py rename to examples/typing_simpletest.py