Mercurial > repos > public > sbplib_julia

comparison README.md @ 842:ef78f730cbb4 feature/setup_documenter

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
More info in the readme
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 14 Jan 2022 10:06:48 +0100
parents 221ce98d2612
children c9e35f1ca269
comparison
equal deleted inserted replaced
841:23bce17a59cb 842:ef78f730cbb4
37 make docs 37 make docs
38 make localdocs 38 make localdocs
39 ``` 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`. 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 41
42 To view the documentation locally simply open `docs/build/index.html` in your web browser.
43
42 When including the `docs/make.jl` script `prettyurls` is set to `false` by default. 44 When including the `docs/make.jl` script `prettyurls` is set to `false` by default.
43 45
44 Including `docs/make.jl` from the REPL may be preferable when repeatadely building the documentation since this avoids compilation latency. 46 Including `docs/make.jl` from the REPL may be preferable when repeatadely building the documentation since this avoids compilation latency.