diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1b9fadc..7467c1d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,7 +4,7 @@ repos: - repo: https://github.com/python/black - rev: 20.8b1 + rev: 22.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f8b2891..33c2a61 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,8 +8,12 @@ # Required version: 2 +build: + os: ubuntu-20.04 + tools: + python: "3" + python: - version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt diff --git a/README.rst b/README.rst index 9cf4da1..fabe38a 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,14 @@ +DEPRECATED - This library has been copied and renamed +===================================================== +The new version of this library is https://github.com/adafruit/Adafruit_CircuitPython_Pixelbuf. +This old version has been archived and will not be maintained. The import name was ``adafruit_pypixelbuf``, and is now: + +.. code:: + + import adafruit_pixelbuf + +On many boards, there is a native implementation of ``adafruit_pixelbuf``, and this Python version is not needed. + Introduction ============ @@ -74,14 +85,11 @@ Documentation API documentation for this library can be found on `Read the Docs `_. +For information on building library documentation, please check out `this guide `_. + Contributing ============ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. - -Documentation -============= - -For information on building library documentation, please check out `this guide `_.