|
|
The tutorial consists of the `rst` and `ipynb` files in the `doc` folder and is generated by calling `make doc` in the build directory. The resulting `html` files can be viewed in a browser by opening `doc/html/index.html` in the build directory.
|
|
|
|
|
|
__Important__:
|
|
|
|
|
|
The `ipynb` files are generated from the `py` files in `doc`, which are links to the `py` files in `demos`. This way `demos` can be viewed by a user separately without the other files in the tutorial cluttering up the everything.
|
|
|
|
|
|
__Changes__ should not be made to the `ipynb` files since those are generated. Change only the `py` files (either in doc or demos doesn't matter since they are the same).
|
|
|
|
|
|
To generate the files in the source folder run `make` (possibly with `-ij8` or similar) in the `doc` folder. If updates to the tutorial on the dune webpage are requires execute
|
|
|
`git commit -a & git push`. The tutorial should then be updated during the nightly build. |
|
|
\ No newline at end of file |