diff README.md @ 858:5088de9b6d65

Merge feature/setup_documenter
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 19 Jan 2022 07:24:36 +0100
parents 0862bed6e6b4
children 87bc91def1ff
line wrap: on
line diff
--- a/README.md	Thu Jan 13 12:43:10 2022 +0100
+++ b/README.md	Wed Jan 19 07:24:36 2022 +0100
@@ -27,3 +27,23 @@
 Pkg.test(test_args=["*/lazy_tensor_operations_test.jl", "Grids/*"])
 ```
 will run any file named `lazy_tensor_operations_test.jl` and all the files in the `Grids` folder.
+
+
+## Generating and using the documentation
+Generating the documentation can be done using either `make` or through activating the `docs` environment and including the script `docs/make.jl` at the REPL.
+
+Using `make` there are three targets
+```shell
+make docs
+make localdocs
+make opendocs
+make help
+```
+The first variant generates files suitable for webserver deployment, i.e with `prettyurls=true`. The second generates files sutible for local viewing in a web browser, i.e `prettyurls=false`. To view the documentation locally simply open `docs/build/index.html` in your web browser. The documentation can be automatically built and opened using
+```shell
+make opendocs
+```
+
+When including the `docs/make.jl` script `prettyurls` is set to `false` by default.
+
+Including `docs/make.jl` from the REPL may be preferable when repeatadely building the documentation since this avoids compilation latency.