Build HTML for each page of your book

Once you've added content and configured your book, it's time tobuild the HTML for each page of your book. We'll use thejupyter-book build command-line tool for this. In the next step,we'll stitch these HTML pages into a book.

Prerequisites

In order to build the HTML for each page, you should have followed the stepsin creating your Jupyter Book structure. You should havea Jupyter Book structure in a local folder on your computer, a collectionof notebook/markdown files in your content/ folder, a _data/toc.yml filethat defines the structure of your book, and any configuration you'd likein the config.yml file.

Build each page's HTML

Now that your book's content is in the content/ folder and you'vedefined your book's structure in _data/toc.yml, you can buildthe HTML for each page of your book.

Do so by running the following command:

jupyter-book build mybookname/

This will:

• Use the links specified in the _data/toc.yml file (pointing to files in /content/) anddo the following:
  • Run nbconvert to turn the content files (e.g., .ipynb, .md, etc) files into HTML
  • Replace relative image file paths so that they work on your new built book
  • Place all these generated files in the mybookname/_build/ directory. After this step is finished, you should have a collection of HTML files in your_build/ folder.

Page HTML caching

By default, Jupyter Book will only build the HTML for pages that havebeen updated since the last time you built the book. This helps reduce theamount of unnecessary time needed to build your book. If you'd like toforce Jupyter Book to re-build a particular page, you can either edit thecorresponding file in the content/ folder, or delete that page's HTMLin the _build/ folder.

Next step: build and publish your book

Now that you've created the HTML for each page of your book, it's timeto stitch them together into a book. That's covered in the next section.

This page was created by The Jupyter Book Community