Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 2.14 KB

README.md

File metadata and controls

75 lines (48 loc) · 2.14 KB
Raw

jupyter-book-template

Publish Docs

A template Jupyter Book for creating publication quality books from Jupyter Notebooks, markdown files, and more.

What does the template include?

This template is a minimally configured, custom styled Jupyter Book, containing some information on how to get started with creating your own publication quality book.

The repository is ready to be cloned for custom use, and has a generic Workflow configured to automatically rebuild and publish your book using GitHub Pages (may require setup if not used before).

How do I use it?

Clone the repository, and setup a Python environment:

  • using pipenv (recommended)
pipenv install
  • using venv
python3 -m venv .venv && source .venv/bin/activate

pip3 install -r requirements.txt

Then

  1. Start by removing the src/chapter* directories.
  2. Add your own content in a directory structure of your choosing.
  3. Link all of the content you wish to include in the book in src/_toc.yml.
  4. Update src/_config.yml as needed.

Building and serving locally

Once you are happy with your content, you can build the book:

  • using pipenv (recommended)
pipenv run build

and serve locally with

pipenv run serve
  • using venv
jupyter-book build src

and serve it locally with

python3 -m http.server -d src/_build/html

Publishing your book

The Workflow file included will automatically rebuild and copy the src/_build/html directory to a new GitHub Pages branch.

If you wish to host the website elsewhere, only a file server is required (e.g. /home/WWW/ on the Bristol servers). To do this, just copy the src/_build/html to the desired location, and point your a web browser there.