Mercurial > repos > public > sbplib_julia
comparison README.md @ 848:be24e6374d24 operator_storage_array_of_table
Merge feature/setup_documenter
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Fri, 14 Jan 2022 13:34:40 +0100 |
| parents | 0862bed6e6b4 |
| children | 87bc91def1ff |
comparison
equal
deleted
inserted
replaced
| 836:91a63b04b1c9 | 848:be24e6374d24 |
|---|---|
| 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 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. | |
| 34 | |
| 35 Using `make` there are three targets | |
| 36 ```shell | |
| 37 make docs | |
| 38 make localdocs | |
| 39 make opendocs | |
| 40 make help | |
| 41 ``` | |
| 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 | |
| 43 ```shell | |
| 44 make opendocs | |
| 45 ``` | |
| 46 | |
| 47 When including the `docs/make.jl` script `prettyurls` is set to `false` by default. | |
| 48 | |
| 49 Including `docs/make.jl` from the REPL may be preferable when repeatadely building the documentation since this avoids compilation latency. |