Skip to content

Commit

Permalink
Merge pull request #142 from bbc/jamessa-docs
Browse files Browse the repository at this point in the history
Link to rendered documentation
  • Loading branch information
j616 authored Nov 3, 2023
2 parents 446fc51 + cf656f8 commit 363d1cd
Showing 1 changed file with 1 addition and 6 deletions.
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,12 +187,7 @@ An additional feature is provided in the form of numpy array access to the data

## Documentation

The API is well documented in the docstrings of the module mediagrains, to view:

```bash
make docs
```
This command will render documentation as HTML in the `/docs` directory.
The API is well documented in the docstrings of the module mediagrains. A rendered version of this documentation is available [here](https://bbc.github.io/rd-apmm-python-lib-mediagrains/mediagrains/mediagrains.html).

Instructions for using the 'new style' grains can be find in [new_style_grains.md](new_style_grains.md)

Expand Down

0 comments on commit 363d1cd

Please sign in to comment.