Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 803 Bytes

File metadata and controls

37 lines (24 loc) · 803 Bytes

Using sphinx for documentation

TODO

Using sphinx-togglebutton for the questions

TODO

Using matplotlib for plotting directives

The matplotlib library includes a sphinx plugin that allows for plot directives. To enable it, ensure that "matplotlib.sphinxext.plot_directive" is included in extensions in conf.py.

For example the following will create a plot:

.. plot::

   import matplotlib.pyplot as plt
   import numpy as np

   xs = np.linspace(0, 10)
   plt.plot(xs, np.cos(xs))

import matplotlib.pyplot as plt import numpy as np

xs = np.linspace(0, 10) plt.plot(xs, np.cos(xs))