From 35de7c6dd9e123ea2f68a60539729cd0518eeffd Mon Sep 17 00:00:00 2001 From: Anton Kullberg <anton.kullberg@liu.se> Date: Fri, 12 Nov 2021 16:19:12 +0100 Subject: [PATCH] readme: added pages pointer --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2099376..153bfc2 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,10 @@ docker run --rm -it -p 8888:8888 gitlab.liu.se:5000/phd-courses/multiple-target- # Documentation The documentation is hosted on Gitlab pages but is also buildable locally in the provided Docker image. -To build the documentation the following procedure is suggested. +The documentation can be found [here](https://phd-courses.gitlab-pages.liu.se/multiple-target-tracking). + +#### Building the documentation locally +To build the documentation the following procedure is suggested. It is assumed that the Docker image has been built already. Otherwise, substitute `targettracking` with `gitlab.liu.se:5000/phd-courses/multiple-target-tracking` below. ``` docker run --rm -it -v "$(pwd)":/home/jovyan/work targettracking pdoc --html --output-dir work/html/ src/ ``` -- GitLab