Sphinx Setup

To initially setup a Sphinx project, please refer here.

Note

QuantEcon is currently developing a custom quickstart to assist with setting up a sphinx project customised to use this extension and provide more guidance with the configuration process.

Update the project conf.py file to include the jupyter extension and add the desired configuration settings (see Extension Configuration section for details):

extensions = ["sphinxcontrib.jupyter"]

once the extension is installed you can then run:

make jupyter

The Extension Configuration section includes details on how to configure the extension.