jupinx-quickstart

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.

Installation

To install jupinx:

Warning

This project is not yet released through PyPI. Please instead install using: python setup.py install from within a clone of the repository.

pip install jupinx

Note

Windows is currently not tested or supported. See Issue #7

Running jupinx-quickstart

Once, jupinx is installed, to run the jupinx quickstart program you can run:

jupinx-quickstart

on a terminal.

The jupinx-quickstart will:

1. setup a directory structure for your project
2. check for sphinxcontrib-jupyter installation
3. construct Makefile and conf.p` files
4. a parent document source/index.rst

after running the quickstart you may run make jupyter to build the project

Directory structure

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
  • Makefile: provides make commands for compiling the project
  • conf.py: provides configuration for sphinx-build

Note

sphinx is actually 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