A quickstart utility has been developed to help users get setup quickly with Sphinx, configured in a way to get building collections of Jupyter notebooks quickly.
To install jupinx:
pip install jupinx
or you can upgrade to the latest version using:
pip install --upgrade jupinx
Windows is currently not tested or supported.
See Issue #7
jupinx is installed, to run the jupinx quickstart program you can run:
on a terminal.
- setup a directory structure for your project
- check for
- construct a parent document
- setup the project to use the
after running the quickstart you may run:
make jupyterto build the project as notebooks
make websiteto build the project as a website (via sphinxcontrib-jupyter)
make pdfto build the project as a pdf (via sphinxcontrib-jupyter)
quickstart sets up the Makefile with some conf.py setting overrides to
enable building jupyter and website (rather than via a specific builder)
The following directory structure is adopted during the setup:
source: where source RST files should be added
source/_static: where _static assets such as figures and images are kept
theme: allows you to customise builders using themes and templates
makecommands for compiling the project
conf.py: provides configuration for
sphinx is quite flexible in setting up a project in a way
that suits your workflow. If you want to change directory structure this
is likely possible but you will need to update your
Makefile after the
quickstart is finished. Please refer to sphinx docs
for further information.