Skip to content

Commit b4dcc98

Browse files
Adding Tutorials compilation instructions
1 parent 2013958 commit b4dcc98

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,26 @@ Visit one of the following pages, depending of your needs, and start enjoying!
3333
- [**STABLE**](https://gridap.github.io/Tutorials/stable) — **Tutorials for the most recently tagged version of Gridap.jl.**
3434
- [**DEVEL**](https://gridap.github.io/Tutorials/dev) — *Tutorials for the in-development version of Gridap.jl.*
3535

36+
## Generating tutorials locally (only if you intend to contribute to the tutorials as a developer)
37+
38+
If you want to contribute to the tutorials, e.g., to make changes in their sources, you might need to generate (render) them locally to see whether the changes in the sources produce the expected outcome in the output (i.e., Jupyter notebooks + HTML pages). To this end, you have to follow the following instructions once:
39+
40+
```
41+
julia --project=docs # From the Unix shell, located at the root of Tutorials repo
42+
develop . # From the Julia package manager prompt
43+
instantiate # ""
44+
build # ""
45+
exit() # From the Julia REPL
46+
```
47+
48+
and then, each time that you perform a change on the tutorial sources, you have to execute the following command:
49+
50+
```
51+
julia --project=docs docs/make.jl # From the Unix shell, located at the root of Tutorials repo
52+
```
53+
54+
to generate the tutorials. The files generated are available at `Tutorials/docs/build/`.
55+
3656

3757
## Gridap community
3858

@@ -62,3 +82,4 @@ In order to give credit to the `Gridap` contributors, we simply ask you to cite
6282

6383
Please, contact the project administrators, [Santiago Badia](mailto:santiago.badia@monash.edu) and [Francesc Verdugo](mailto:fverdugo@cimne.upc.edu), for further questions about licenses and terms of use.
6484

85+

0 commit comments

Comments
 (0)