Merge branch 'preparing-for-v2.1.2'

Author: 2bndy5

.gitignore

@@ -26,7 +26,6 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
-_version.py
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

circuitpython_nrf24l01/__init__.py

@@ -1,9 +1,6 @@
 """circuitpython-nrf24l01 package version and repository information. This is meant to
 be used with adafruit/circup package manager to manage packages on Circuitpython devices
 like pip does for CPython devices."""
-try:
-    from ._version import __version__
-except ImportError:
-    __version__ = "0.0.0-auto.0"
 
+__version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/nRF24/CircuitPython_nRF24L01.git"

docs/_static/custom_material.css

@@ -3,13 +3,9 @@
   font-size: 0.75rem;
 }
 
-.md-typeset .admonition.tip>.admonition-title::before,
-.md-typeset .admonition.hint>.admonition-title::before {
-  mask-image: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12,3L1,9L12,15L21,10.09V17H23V9M5,13.18V17.18L12,21L19,17.18V13.18L12,17L5,13.18Z" /></svg>');
-}
-
 .md-typeset .admonition.seealso>.admonition-title::before {
-  mask-image: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M572.52 241.4C518.29 135.59 410.93 64 288 64S57.68 135.64 3.48 241.41a32.35 32.35 0 0 0 0 29.19C57.71 376.41 165.07 448 288 448s230.32-71.64 284.52-177.41a32.35 32.35 0 0 0 0-29.19zM288 400a144 144 0 1 1 144-144 143.93 143.93 0 0 1-144 144zm0-240a95.31 95.31 0 0 0-25.31 3.79 47.85 47.85 0 0 1-66.9 66.9A95.78 95.78 0 1 0 288 160z"/></svg>');
+  /* svg data from octicons/eye-24 */
+  mask-image: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15.5 12a3.5 3.5 0 1 1-7 0 3.5 3.5 0 0 1 7 0z"/><path fill-rule="evenodd" d="M12 3.5c-3.432 0-6.125 1.534-8.054 3.24C2.02 8.445.814 10.352.33 11.202a1.6 1.6 0 0 0 0 1.598c.484.85 1.69 2.758 3.616 4.46C5.876 18.966 8.568 20.5 12 20.5c3.432 0 6.125-1.534 8.054-3.24 1.926-1.704 3.132-3.611 3.616-4.461a1.6 1.6 0 0 0 0-1.598c-.484-.85-1.69-2.757-3.616-4.46C18.124 5.034 15.432 3.5 12 3.5zM1.633 11.945c.441-.774 1.551-2.528 3.307-4.08C6.69 6.314 9.045 5 12 5c2.955 0 5.309 1.315 7.06 2.864 1.756 1.553 2.866 3.307 3.307 4.08a.111.111 0 0 1 .017.056.111.111 0 0 1-.017.056c-.441.774-1.551 2.527-3.307 4.08C17.31 17.685 14.955 19 12 19c-2.955 0-5.309-1.315-7.06-2.864-1.756-1.553-2.866-3.306-3.307-4.08A.11.11 0 0 1 1.616 12a.11.11 0 0 1 .017-.055z"/></svg>');
   background-color: hsl(301, 100%, 63%);
 }
 
@@ -23,7 +19,6 @@
 }
 
 .md-typeset .admonition.important>.admonition-title::before {
-  mask-image: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M256 8C119.043 8 8 119.083 8 256c0 136.997 111.043 248 248 248s248-111.003 248-248C504 119.083 392.957 8 256 8zm0 110c23.196 0 42 18.804 42 42s-18.804 42-42 42-42-18.804-42-42 18.804-42 42-42zm56 254c0 6.627-5.373 12-12 12h-88c-6.627 0-12-5.373-12-12v-24c0-6.627 5.373-12 12-12h12v-64h-12c-6.627 0-12-5.373-12-12v-24c0-6.627 5.373-12 12-12h64c6.627 0 12 5.373 12 12v100h12c6.627 0 12 5.373 12 12v24z"/></svg>');
   background-color: hsl(123, 100%, 63%);
 }
 
@@ -84,7 +79,3 @@ thead {
   background-color: var(--md-default-fg-color--light);
   color: var(--md-primary-bg-color);
 }
-
-.viewcode-block .viewcode-back {
-  float: right;
-}

docs/conf.py

@@ -126,6 +126,41 @@
         "search.share",
         "navigation.tabs.sticky",
     ],
+    "icon": {
+        "repo": "fontawesome/brands/github",
+        "admonition": {
+            "note": "material/note-edit-outline",
+            "tip": "material/school",
+            "warning": "octicons/alert-16",
+        },
+    },
+    "social": [
+        {
+            "icon": "fontawesome/brands/github",
+            "link": "https://github.com/nRF24/CircuitPython_nRF24L01",
+        },
+        {
+            "icon": "fontawesome/brands/python",
+            "link": "https://pypi.org/project/circuitpython-nrf24l01/",
+        },
+        {
+            "icon": "fontawesome/brands/discord",
+            "link": "https://adafru.it/discord",
+        },
+        {
+            "icon": "simple/adafruit",
+            "link": "https://www.adafruit.com/",
+        },
+        {
+            "icon": "simple/sparkfun",
+            "link": "https://www.sparkfun.com/",
+        },
+        {
+            "name": "CircuitPython Downloads",
+            "icon": "octicons/download-24",
+            "link": "https://circuitpython.org",
+        },
+    ],
     "palette": [
         {
             "media": "(prefers-color-scheme: dark)",

docs/examples.rst

@@ -105,11 +105,13 @@ Reading the scanner output
 The output of the scanner example is supposed to be read vertically (as columns).
 So, the following
 
-    | 000
-    | 111
-    | 789
-    | ~~~
-    | 13-
+.. code-block:: text
+
+    000
+    111
+    789
+    ~~~
+    13-
 
 should be interpreted as
 

docs/index.rst

@@ -31,18 +31,6 @@
     contributing
     troubleshooting
 
-.. toctree::
-    :caption: Other Links
-    :hidden:
-
-    Download <https://github.com/2bndy5/CircuitPython_nRF24L01/releases/latest>
-    CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
-    CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
-    Discord Chat <https://adafru.it/discord>
-    Adafruit Learning System <https://learn.adafruit.com>
-    Adafruit Blog <https://blog.adafruit.com>
-    Adafruit Store <https://www.adafruit.com>
-
 .. only:: html
 
     .. image:: https://img.shields.io/static/v1?label=Visual%20Studio%20Code&message=Use%20Online%20IDE&color=blue&logo=visualstudiocode&logoColor=3f9ae6
@@ -62,7 +50,7 @@ This is a Circuitpython driver library for the nRF24L01(+) transceiver.
 
 Originally this code was a Micropython module written by Damien P. George
 & Peter Hinch which can still be found `here
-<https://github.com/micropython/micropython/tree/master/drivers/nrf24l01>`_
+<https://github.com/micropython/micropython-lib/tree/master/micropython/drivers/radio/nrf24l01>`_
 
 The Micropython source has since been rewritten to expose all the nRF24L01's
 features and for Circuitpython compatible devices (including linux-based
@@ -220,11 +208,11 @@ All examples can be imported from within an interactive python REPL.
            Run slave() on receiver
            Run master() on transmitter
        >>> master()
-       Transmission successful! Time to Transmit: 3906.25 us. Sent: 0.0
-       Transmission successful! Time to Transmit: 2929.69 us. Sent: 0.01
-       Transmission successful! Time to Transmit: 2929.69 us. Sent: 0.02
-       Transmission successful! Time to Transmit: 3906.25 us. Sent: 0.03
-       Transmission successful! Time to Transmit: 4882.81 us. Sent: 0.04
+       Transmission successful! Time to Transmit: 1563.904 us. Sent: 0.0
+       Transmission successful! Time to Transmit: 1804.938 us. Sent: 0.01
+       Transmission successful! Time to Transmit: 1690.977 us. Sent: 0.02
+       Transmission successful! Time to Transmit: 1674.681 us. Sent: 0.03
+       Transmission successful! Time to Transmit: 1729.976 us. Sent: 0.04
 
 For CircuitPython devices
 ---------------------------
@@ -267,7 +255,7 @@ take Amazon or eBay for granted! There are other wireless transceivers that are
 with this library. For instance, the esp8266-01 (also sold in packs) is NOT compatible with
 this library, but looks very similar to the nRF24L01+ and could lead to an accidental purchase.
 
-.. seealso::
+.. warning::
     Beware, there are also `nrf24l01(+) clones and counterfeits`_ that may not work the same.
 
 Power Stability

pyproject.toml

@@ -60,7 +60,6 @@ version_scheme= "no-guess-dev"
 # Test PyPI does not support local versions.
 local_scheme = "no-local-version"
 fallback_version = "0.0.0"
-write_to = "circuitpython_nrf24l01/_version.py"
 
 [tool.pytest.ini_options]
 minversion = "6.0"