File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 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+
Original file line number Diff line number Diff line change 6969 - About :
7070 - License : license.md
7171 - Contribute : contribute.md
72+ - Website : website.md
7273
You can’t perform that action at this time.
0 commit comments