Skip to content

Commit

Permalink
add instructions for adding a jupyter noteboko
Browse files Browse the repository at this point in the history
  • Loading branch information
nsheff committed Mar 19, 2024
1 parent 8d99a39 commit ce97a53
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,13 @@ jupyter:
```

There, you can specify which folders contain notebooks, and to where they should be rendered as markdown.

#### Rendering jupyter notebooks in this repository

By convention, we're putting jupyter notebooks in a `/notebooks` subfolder under each tool (look around for examples). These are then built into the `code/<notebook_name>.md` file by the authodoc.py. So, to add a new notebook:

1. put the notebook into a `<module>/notebooks/<notebook_name>.ipynb`
2. make sure that's listed in the `jupyter` section of the yaml (it already should be there if you're adding a notebook to an existing folder).
3. link to the notebook in `mkdocs.yaml` by linking to `<module>/code/<notebook_name>.md`.
4. you can build your rendered markdown version by running `python autodoc.py`.

0 comments on commit ce97a53

Please sign in to comment.