Mercurial > repos > public > sbplib_julia

comparison README.md @ 1302:68dd0c9f5cac tooling/benchmarks

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add some notes
author Jonatan Werpers <jonatan@werpers.com>
date Thu, 23 Mar 2023 08:40:58 +0100
parents f19c51ddbd72
children 2b5480e2d4bf 471a948cd2b2
comparison
equal deleted inserted replaced
1301:e1aefebe4ea2 1302:68dd0c9f5cac
70 70
71 Using `make` there are four targets for documentation 71 Using `make` there are four targets for documentation
72 ```shell 72 ```shell
73 make docs # generates files suitable for webserver deployment, i.e with `prettyurls=true` 73 make docs # generates files suitable for webserver deployment, i.e with `prettyurls=true`
74 make localdocs # generates files suitable for local viewing in a web browser, i.e `prettyurls=false` 74 make localdocs # generates files suitable for local viewing in a web browser, i.e `prettyurls=false`
75 make opendocs # view documentation locally 75 make opendocs # build and view documentation locally
76 make cleandocs # cleans up generated files 76 make cleandocs # cleans up generated files
77 ``` 77 ```
78 78
79 Alternatively, to view the documentation locally simply open `docs/build/index.html` in your web browser. When including the `docs/make.jl` script `prettyurls` is set to `false` by default. 79 Alternatively, to view the documentation locally simply open `docs/build/index.html` in your web browser. When including the `docs/make.jl` script `prettyurls` is set to `false` by default.
80 80