comparison 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
comparison
equal deleted inserted replaced
839:d138a3e9fd67 840:221ce98d2612
25 filters to be run. For example 25 filters to be run. For example
26 ``` 26 ```
27 Pkg.test(test_args=["*/lazy_tensor_operations_test.jl", "Grids/*"]) 27 Pkg.test(test_args=["*/lazy_tensor_operations_test.jl", "Grids/*"])
28 ``` 28 ```
29 will run any file named `lazy_tensor_operations_test.jl` and all the files in the `Grids` folder. 29 will run any file named `lazy_tensor_operations_test.jl` and all the files in the `Grids` folder.
30
31
32 ## Generating the documentation
33 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.
34
35 Using `make` there are two targets
36 ```shell
37 make docs
38 make localdocs
39 ```
40 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`.
41
42 When including the `docs/make.jl` script `prettyurls` is set to `false` by default.
43
44 Including `docs/make.jl` from the REPL may be preferable when repeatadely building the documentation since this avoids compilation latency.