Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 1.08 KB

README.rst

File metadata and controls

34 lines (20 loc) · 1.08 KB

Project Elara Jupyterbook v2 Test Book

This is a fork of the readthedocs Jupyterbook template used to test Jupyterbook v2 for an eventual migration (see elaraproject/elara-handbook#7).

To test, clone and enter the repo, then create a virtual env

python -m venv .venv
# Windows
source .venv/Scripts/activate
# Mac/Linux
source .venv/bin/activate

Then install Jupyterbook v2:

pip install "jupyter-book>=2"

Also make sure you have LaTeX installed, there are distributions with installers like TeX Live or MikTeX. Then to run the book on localhost do:

jupyter book start

This creates a local web server to preview the web version. To build a PDF you must have LaTeX pre-installed. Then run:

jupyter book build --pdf

This should output a book in the _build/exports/<somefile.pdf>.