From 356d6de84bbf69d6fcb63d6dbd3f45856a01aa34 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 25 Mar 2024 08:57:45 +0100 Subject: [PATCH] Update jupyter-book-setup.md --- book/installation-and-setup/jupyter-book-setup.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/book/installation-and-setup/jupyter-book-setup.md b/book/installation-and-setup/jupyter-book-setup.md index 50e4247..a808dd3 100644 --- a/book/installation-and-setup/jupyter-book-setup.md +++ b/book/installation-and-setup/jupyter-book-setup.md @@ -2,10 +2,20 @@ Jupyter Book is just a regular Python package, so it can be installed by using `pip` or `conda`: - pip install jupyter-book +``` +pip install jupyter-book +``` Nevertheless, it's always a good idea make a fresh `conda` environment when starting a new project. +## Build a book + +As soon as you've installed jupyter-book you can build your book locally. The official [jupyter-book](https://jupyterbook.org/en/stable/basics/build.html) documentation is quite extensive. Only one note, it's advised to use `--all` whenever building a book to make sure the table of contents fully updates: + +``` +jupyter-book build --all +``` + ## View the book locally Once the build process is completed successfully, you will see the file location in your terminal output. Simply open this in the browser (you may have to copy/paste).