-
Notifications
You must be signed in to change notification settings - Fork 19
Build JupyterBook locally
Mathew Biddle edited this page Jul 7, 2021
·
3 revisions
- Jupyter-book command line interface: https://jupyterbook.org/basics/build.html
- Git: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
- Jupyter{Book}: https://jupyterbook.org/intro.html
- Web Browser
Install jupyter-book:
conda install jupyter-book
Clone the notebooks_demo repository.
git clone https://github.com/ioos/notebooks_demos.git
Once you have cloned the repository, you have all the required notebooks cloned onto your system (in the jupyterbook/content folder).
Run the following command to build the JupyterBook.
jupyter-book build jupyterbook/
The command should be run relative to the jupyterbook/ directory.
If you are in the jupyterbook/ directory, you can build the book using
juyter-book build .
Your book's HTML pages are here:
jupyterbook\_build\html\
You can look at your book by opening this file in a browser:
jupyterbook\_build\html\index.html
Or, use the full link displayed in the terminal to view the website.
To entirely remove the folders in the _build/ directory:
jupyter-book clean jupyterbook/ --all