nbsphinx

• Homepage: https://github.com/spatialaudio/nbsphinx/

• Documentation: https://nbsphinx.readthedocs.io/

nbsphinx allows you to publish Jupyter notebooks as documentation pages.

Example

This whole page is written in a Jupyter Notebook (see Show Source).

import datetime
datetime.datetime.now()

datetime.datetime(2023, 12, 13, 9, 38, 49, 403515)

import matplotlib.pyplot as plt
import numpy as np

Data for plotting:

t = np.arange(0.0, 2.0, 0.01)
s = 1 + np.sin(2 * np.pi * t)

fig, ax = plt.subplots()
ax.plot(t, s)
ax.set(
    xlabel='time (s)',
    ylabel='voltage (mV)',
    title='About as simple as it gets, folks',
)
ax.grid()

Installation

pip install nbsphinx

Configuration

# conf.py
extensions = [
    '...',
    'nbsphinx',
]