Mercurial > repos > public > sbplib_julia

comparison README.md @ 846:c9e35f1ca269 feature/setup_documenter

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Make the targets properly depend on the source files
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 14 Jan 2022 13:24:15 +0100
parents ef78f730cbb4
children 0862bed6e6b4
comparison
equal deleted inserted replaced
845:b4f542b4f2e4 846:c9e35f1ca269
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. 42 To view the documentation locally simply open `docs/build/index.html` in your web browser. The documentation can be automatically built and opened using
43 ```shell
44 make opendocs
45 ```
43 46
44 When including the `docs/make.jl` script `prettyurls` is set to `false` by default. 47 When including the `docs/make.jl` script `prettyurls` is set to `false` by default.
45 48
46 Including `docs/make.jl` from the REPL may be preferable when repeatadely building the documentation since this avoids compilation latency. 49 Including `docs/make.jl` from the REPL may be preferable when repeatadely building the documentation since this avoids compilation latency.