Mercurial > repos > public > sbplib_julia
changeset 847:0862bed6e6b4 feature/setup_documenter
Update README.md
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Fri, 14 Jan 2022 13:32:42 +0100 |
| parents | c9e35f1ca269 |
| children | be24e6374d24 9ab2651ea00b |
| files | README.md |
| diffstat | 1 files changed, 5 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
diff -r c9e35f1ca269 -r 0862bed6e6b4 README.md --- a/README.md Fri Jan 14 13:24:15 2022 +0100 +++ b/README.md Fri Jan 14 13:32:42 2022 +0100 @@ -29,17 +29,17 @@ will run any file named `lazy_tensor_operations_test.jl` and all the files in the `Grids` folder. -## Generating the documentation +## Generating and using the documentation 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. -Using `make` there are two targets +Using `make` there are three targets ```shell make docs make localdocs +make opendocs +make help ``` -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`. - -To view the documentation locally simply open `docs/build/index.html` in your web browser. The documentation can be automatically built and opened using +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 ```shell make opendocs ```