From 528289a2a231669c7544c2113a3331b28b58b163 Mon Sep 17 00:00:00 2001 From: David Binder <david.binder@uni-tuebingen.de> Date: Mon, 24 Oct 2022 16:07:06 +0200 Subject: [PATCH] Add link to readthedocs.io --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3376f95..d15c02a 100644 --- a/README.md +++ b/README.md @@ -4,5 +4,5 @@ This repository provides the `hpc` binary which produces coverage reports in var ## Documentation -The documentation of the `hpc-binary` is available online on readthedocs (TODO). +The documentation of the `hpc-binary` is available online on [readthedocs.io](https://hpc-bin.readthedocs.io/en/latest/index.html). In order to build the documentation locally, you have to install the [sphinx](https://www.sphinx-doc.org/en/master/) documentation generator on your machine, as well as the `sphinx_rtd_theme`, and invoke `make html` in the `docs/` subdirectory. \ No newline at end of file -- GitLab