Jupyter Notebook

Now lets have some fun and add a Jupyter Notebook to our website

Install jupytext

First, lets install jupytext

This will allows us to make .ipynb files from .py using the percent format

conda install -c conda-forge jupytext

or

pip install jupytext

The percent format

# %% [markdown]
# # A Markdown cell
# - You can do all the fun stuff markdown has to offer

# %% [markdown]
# ## Another Markdown cell


# %%
# This is a code cell
class A():
    def one():
        return 1

    def two():
        return 2

# %%
# This is another code cell
import numpy as np

mylist = np.arange(0,10)
print(f"this is my list {mylist}")

Add a Notebook page to toctree

In the source/ folder make a file call mybook.py

touch mybook.py

Open mybook.py and copy past the Percent format example above to mybook.py

Convert .py to .ipynb

In the terminal run the following command to convert .py to .ipynb

jupytext --to notebook mybook.py

Head back over to your index.rst and add mybook.ipynb to the toctree.

.. WFRT-DEMO documentation master file, created by
sphinx-quickstart on Wed Sep 16 13:47:52 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to WFRT-DEMO's documentation!
=====================================

.. toctree::
:maxdepth: 2
:caption: Contents:

   api
   mymarkdown
   mymath
   My Book <mybook.ipynb>


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Note

Adding mybook as My Book <mybook.ipynb> allows you to set a specific header name to the table of contents. I also did it this way as we have a mybook.py file, and sphinx gets confused without explicitly defining the file extension.

Lets rebuild our webiste

make clean
make html

Push this work to GitHub and see the new markdown page.

git add .
git commit -m "added mybook to docs"
git push