issues
search
spacecheese
/
bluez_peripheral
A library for building BLE peripherals using GATT and bluez
MIT License
42
stars
8
forks
source link
Rework Documentation
#25
Open
spacecheese
opened
1 year ago
spacecheese
commented
1 year ago
[x] Rewrite static documentation.
[x] Fixes for main README.md
[x] Include README.md in index (instead of having two main pages).
[x] Change to Furo theme
[x] Add black source formatting check
[x] Add autogen rule for api reference
[x] Rename some internal functions to start with _ (so they don't show up in docs)
[x] 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.7 release and broken links)
[ ] Add
interrogate
docstring checking
[ ] Add type hint checking
[ ] Automated testing for code samples
[ ] characteristic.py type annotations
[ ] descriptor.py type annotations
[ ] Error docstrings
[ ] Other missing docstrings
[ ] Investigate Advertising Includes and Advertisable Characteristics (advertisting.rst)
[ ] Investigate OOB pairing (pairing.rst, possibly defer)
[ ] More complete testing for UUID changes
spacecheese
commented
1 year ago
Merge after
#23