Sphinx SetupΒΆ

To initially setup a Sphinx project, please refer here.

Note

QuantEcon has developed a jupinx-quickstart that can assist with setting up a repository to get you up and running quickly. Please refer to the Jupinx Project for more details.

You can use the sphinx quickstart and 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 in your conf.py.