From b3e74b42be2bffae39ad1904ac880f79ac87df21 Mon Sep 17 00:00:00 2001 From: "Brearton, Richard (DLSLtd,RAL,LSCI)" Date: Mon, 25 Jul 2022 15:02:34 +0100 Subject: [PATCH] Updated readme to link to the documentation --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ca4f241..e0f8869 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,11 @@ Make sure that your installation is functioning by running `pytest`. ### Documentation -To generate documentation, make sure you have sphinx installed on your system. +The documentation for this package can be found at https://islatu.readthedocs.io/en/latest/ + +An example of a typical data reduction workflow can be found at https://islatu.readthedocs.io/en/latest/i07_reflectivity.html + +To build the documentation, make sure you have sphinx installed on your system. Go to the docs directory and run ```