From c762a7ebcaef23220b20280db2546415a5b1622e Mon Sep 17 00:00:00 2001 From: vincent d warmerdam Date: Mon, 24 Jan 2022 13:35:07 +0100 Subject: [PATCH] Update readme.md --- readme.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/readme.md b/readme.md index 590fe4b..c62d875 100644 --- a/readme.md +++ b/readme.md @@ -197,3 +197,19 @@ Alternatively you may also run this via the `Makefile`: ``` make install ``` + +## Documentation + +If you want to build the documentation locally you can do so via; + +``` +mkdocs serve +``` + +If you want to deplot the docs to GitHub you can run; + +``` +mkdocs gh-deploy +``` + +This will deploy a new version to the `docs` branch, which is picked up by GitHub pages.