Skip to content

Commit 1bafd10

Browse files
committed
Section on updating website
1 parent 07fa863 commit 1bafd10

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

docs/website.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Website
2+
3+
4+
This website is build using the `mkdocs` package. To build the project locally for
5+
testing, run `uv run mkdocs serve`.
6+
7+
All files for the website are located in the `docs/` folder and can be edited there as
8+
markdown files. The website is build and published using GitHub actions.
9+
10+
If you intend to add a new page to the website, please add a new markdown file under the
11+
docs folder and edit the `nav` section in the `mkdocs.yml` file to include it in the
12+
navigation bar.
13+
14+
# Submitting Notebooks
15+
16+
The notebooks in the `notebooks` can be converted _locally_ to to markdown files with
17+
the `make notebooks` command. Under the hood it uses nbconvert to run the notebooks and
18+
convert them to `.md` files. As this may depend on hardware acceleration the command has
19+
to be ran locally before commiting to the repository. The outputs are stored under the
20+
`docs/notebooks` folder and new notebooks have to be added manually to the navigation bar
21+
in the `mkdocs.yml` file.
22+

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,4 +69,5 @@ nav:
6969
- About:
7070
- License: license.md
7171
- Contribute: contribute.md
72+
- Website: website.md
7273

0 commit comments

Comments
 (0)