From effb3e1d2b9bb03421940245576aa4c2db122a16 Mon Sep 17 00:00:00 2001 From: Talley Lambert Date: Sun, 25 Jun 2023 16:46:35 -0400 Subject: [PATCH] chore: update docs ci name and readme --- .github/workflows/docs.yml | 3 ++- README.md | 9 ++++++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3b78f2a..1cf8586 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,4 +1,5 @@ -name: ci +name: docs + on: push: branches: diff --git a/README.md b/README.md index 8a985ea..1a95131 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ compatibility and data extraction. (If you find an nd2 file that fails in some way, please [open an issue](https://github.com/tlambert03/nd2/issues/new) with the file!) +### :book: [Documentation](https://tlambert03.github.io/nd2) + ## install ```sh @@ -56,7 +58,12 @@ than the built-in `xml` module. To install with support for `lxml` use: pip install nd2 lxml ``` -## usage and API +## Usage and API + +Full API documentation is available at +[https://tlambert03.github.io/nd2](https://tlambert03.github.io/nd2) + +Quick summary below: ```python import nd2