Merge pull request #160 from kevincar/102-need-notify-example-and-documentation

102 need notify example and documentation

Author: kevincar

.github/workflows/build-and-test.yml

@@ -31,6 +31,7 @@ jobs:
         python -m pip install --upgrade pip
         pip install flake8 mypy pytest
         pip install -r requirements.txt
+        pip install -r docs/requirements.txt
     - name: Install bluetooth ctl linux
       if: runner.os == 'Linux'
       run: |
@@ -52,6 +53,10 @@ jobs:
       if: runner.os != 'Windows'
       run: |
           mypy bless
+    - name: Build Sphinx docs
+      if: runner.os == 'Linux' && matrix.python-version == '3.11'
+      run: |
+        sphinx-build -b html docs docs/_build/html
     - name: Test with pytest
       run: |
         python -m pytest

.gitignore

@@ -4,3 +4,4 @@
 /dist
 .mypy_cache/
 *~
+docs/_build

.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt

README.md

@@ -7,6 +7,8 @@ Test](https://github.com/kevincar/bless/actions/workflows/build-and-test.yml/bad
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/bless)
 [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
+Documentation: https://bless.readthedocs.io/en/latest/
+
 Bless is an acronym for Bluetooth Low Energy (BLE) Server Supplement.
 
 Bless provides an OS-independent python package for creating a BLE Generic

bless/__init__.py

@@ -1,7 +1,10 @@
-# type: ignore
+import os
 import sys
 
-if sys.platform == "darwin":
+# Avoid OS-specific imports during docs builds.
+if os.environ.get("BLESS_DOCS_BUILD"):
+    pass
+elif sys.platform == "darwin":
 
     # Server
     from bless.backends.corebluetooth.server import (  # noqa: F401