Skip to content

Commit 2db7bb0

Browse files
committed
Update README
1 parent f6b5684 commit 2db7bb0

File tree

1 file changed

+28
-12
lines changed

1 file changed

+28
-12
lines changed

README.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Documentation and Tutorials for Turing.jl
22

3-
This repository is part of [Turing.jl's](https://turinglang.org/) website (i.e. `https://turinglang.org/docs/`). It contains the Turing.jl documentation and tutorials.
4-
- The `main` branch contains the quarto source
3+
This repository hosts the code for the main Turing.jl documentation `https://turinglang.org/docs/`.
4+
It contains the Turing.jl documentation and tutorials.
5+
6+
- The `main` branch contains the Quarto source.
57
- The `gh-pages` branch contains the `html` version of these documents compiled from the `main` branch.
68

79
## Local development
@@ -29,7 +31,10 @@ Once you have Quarto installed, you can follow these steps:
2931
julia --project=. -e 'using Pkg; Pkg.instantiate()'
3032
```
3133

32-
4. Preview the website using Quarto Preview:
34+
4. Preview the website using Quarto.
35+
36+
> [!WARNING]
37+
> This will take a _very_ long time, as it will build every tutorial from scratch. See below for ways to speed this up.
3338

3439
```bash
3540
quarto preview
@@ -54,18 +59,29 @@ Once you have Quarto installed, you can follow these steps:
5459

5560
Then, navigate to http://localhost:8000/ in your web browser.
5661

57-
Note that rendering the entire documentation site can take a long time (usually multiple hours).
58-
If you wish to speed up local rendering, there are two options available:
62+
## Faster rendering
63+
64+
Note that rendering the entire documentation site can take a long time (usually multiple hours).
65+
If you wish to speed up local rendering, there are two options available:
66+
67+
1. Render a single tutorial or `qmd` file without compiling the entire site.
68+
To do this, pass the `qmd` file as an argument to `quarto render`:
69+
70+
```
71+
quarto render path/to/index.qmd
72+
```
5973

60-
- Download the most recent `_freeze` folder from the [GitHub releases of this repo](https://github.com/turinglang/docs/releases), and place it in the root of the project.
61-
This will allow Quarto to reuse the outputs of previous computations for any files which have not been changed since that `_freeze` folder was created.
74+
(Note that `quarto preview` does not support this single-file rendering.)
6275

63-
- Alternatively, render a single tutorial or `qmd` file without compiling the entire site.
64-
To do this, pass the `qmd` file as an argument to `quarto render`:
76+
2. Download the most recent `_freeze` folder from the [GitHub releases of this repo](https://github.com/turinglang/docs/releases), and place it in the root of the project.
77+
The `_freeze` folder stores the cached outputs from a previous build of the documentation.
78+
If it is present, Quarto will reuse the outputs of previous computations for any files for which the source is unchanged.
6579

66-
```
67-
quarto render path/to/index.qmd
68-
```
80+
Note that the validity of a `_freeze` folder depends on the Julia environment that it was created with, because different package versions may lead to different outputs.
81+
In the GitHub release, the `Manifest.toml` is also provided, and you should also download this and place it in the root directory of the docs.
82+
83+
If there isn't a suitably up-to-date `_freeze` folder in the releases, you can generate a new one by [triggering a run for the `create_release.yml` workflow](https://github.com/TuringLang/docs/actions/workflows/create_release.yml).
84+
(You will need to have the appropriate permissions; please create an issue if you need help with this.)
6985
7086
## Troubleshooting build issues
7187

0 commit comments

Comments
 (0)