Rendering Jupyter Notebooks with mkdocs

[abadithela]

This post documents the changes we had to introduce to host Jupyter notebooks using mkdocs.

• Using mkdocs-jupyter
• Edit the pyproject.toml to include mkdocs-jupyter under the docs section
• Edit the mkdocs.yml to include mkdocs-jupyter as a plug-in and edit the table of contents under the case studies section to link to the relevant Jupyter notebook
• After changing the pyproject.toml and mkdocs.yml files, re-install gear using pdm install
• If the Jupyter notebooks are located outside the docs folder, to render the Jupyter notebooks using mkdocs, we need to create a symbolic link of the Jupyter notebook inside the docs folder. Symlinks have to be created carefully: see here (https://www.baeldung.com/linux/too-many-levels-of-symlinks)
• For this, we edits the docs_serve function inside duties.py. Take a look at the duties.py inside the confmatrix branch.
• Now, run make docs-serve.