Mercurial > repos > public > sbplib_julia

comparison README.md @ 847:0862bed6e6b4 feature/setup_documenter

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update README.md
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 14 Jan 2022 13:32:42 +0100
parents c9e35f1ca269
children 87bc91def1ff
comparison
equal deleted inserted replaced
846:c9e35f1ca269 847:0862bed6e6b4
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 30
31 31
32 ## Generating the documentation 32 ## Generating and using 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. 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 34
35 Using `make` there are two targets 35 Using `make` there are three targets
36 ```shell 36 ```shell
37 make docs 37 make docs
38 make localdocs 38 make localdocs
39 make opendocs
40 make help
39 ``` 41 ```
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`. 42 The first variant generates files suitable for webserver deployment, i.e with `prettyurls=true`. The second generates files sutible for local viewing in a web browser, i.e `prettyurls=false`. To view the documentation locally simply open `docs/build/index.html` in your web browser. The documentation can be automatically built and opened using
41
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 43 ```shell
44 make opendocs 44 make opendocs
45 ``` 45 ```
46 46
47 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.