Mercurial > repos > public > sbplib_julia
diff README.md @ 840:221ce98d2612 feature/setup_documenter
Add some instructions to the README
author | Jonatan Werpers <jonatan@werpers.com> |
---|---|
date | Fri, 14 Jan 2022 09:49:47 +0100 |
parents | 1c5600a711ae |
children | ef78f730cbb4 |
line wrap: on
line diff
--- a/README.md Fri Jan 14 09:49:25 2022 +0100 +++ b/README.md Fri Jan 14 09:49:47 2022 +0100 @@ -27,3 +27,18 @@ 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 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 two targets +```shell +make docs +make localdocs +``` +The first variant generates files suitable for webserver deployment, i.e setting `prettyurls=true`. The second generates files sutible for local viewing in a web browser, i.e `prettyurls=false`. + +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.