From 210a50938568fb4e3655c90a354ae97b5dc1e18b Mon Sep 17 00:00:00 2001 From: Gilles Boccon-Gibod Date: Mon, 16 May 2022 20:05:10 -0700 Subject: [PATCH] point to pre-built doc on GitHub Pages host --- .gitignore | 10 ++++++++++ README.md | 3 ++- 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..4f24f011 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +.eggs/ +build/ +dist/ +*.egg-info/ +*~ +bumble/__pycache__ +docs/mkdocs/site +tests/__pycache__ +test-results.xml +bumble/transport/__pycache__ diff --git a/README.md b/README.md index 9133190a..e57b1bfc 100644 --- a/README.md +++ b/README.md @@ -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 ```