point to pre-built doc on GitHub Pages host

This commit is contained in:
Gilles Boccon-Gibod
2022-05-16 20:05:10 -07:00
parent 6ac91f7dec
commit 210a509385
2 changed files with 12 additions and 1 deletions

10
.gitignore vendored Normal file
View File

@@ -0,0 +1,10 @@
.eggs/
build/
dist/
*.egg-info/
*~
bumble/__pycache__
docs/mkdocs/site
tests/__pycache__
test-results.xml
bumble/transport/__pycache__

View File

@@ -13,7 +13,8 @@ Bluetooth Stack for Apps, Emulation, Test and Experimentation
## Documentation
See the documentation under `docs/mkdocs/src`, or build the static HTML site from the markdown text with:
Browse the pre-built [Online Documentation](https://google.github.io/bumble/),
or see the documentation source under `docs/mkdocs/src`, or build the static HTML site from the markdown text with:
```
mkdocs build -f docs/mkdocs/mkdocs.yml
```