Skip to content

Commit

Permalink
Updated readme to link to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RBrearton committed Jul 25, 2022
1 parent 57d0ecd commit b3e74b4
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

```
Expand Down

0 comments on commit b3e74b4

Please sign in to comment.