Documentation and Testing Rework

[spacecheese]

Documentation

• Rewrite static documentation.
• Fixes for main README.md
• Include README.md in index (instead of having two main pages).
• Change to Furo theme
• Add black source formatting check
• Add autogen rule for api reference
• Rename some internal functions to start with _ (so they don't show up in docs)
• Add some test improvements relating to the UUID16 refactor
• Links https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/ should reference a tag (structure of documentation has changed post 5.70 release and broken links)
• Include links to relevant source code
• Add type hint checking
• characteristic.py type annotations
• descriptor.py type annotations
• Error docstrings (and fix references to using the bluez error strings directly)
• Other missing docstrings
• More complete testing for UUID changes
• Fix Serious Documentation Warnings do not cause the workflow to fail #46
• Remove references to internal class members

Testing

• Port existings tests to pytest
• Refactor existing tests to use a better mocking design
• Improve existing unit tests to check that dbus apis are being called appropriately (Improve unit tests to check that dbus apis are used correctly #54)

Add tests for untested functionality

• Advert release callback (Tracked separately Improve test coverage #55)
• Remainder of util functions
• Documentation example code
• (Better) Async characteristic/ descriptor tests

Add additional bluez integration tests

• Implement testing images (see bluez_images)
• Characteristic (Tracked separately Improved Bluez integration testing #10)
• Descriptor
• Service
• Agent
• Advertising

Other

• Add code coverage checking