admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'main' into publish

Browse source
This commit is contained in:
Tom van Woudenberg 2024-03-25 08:57:51 +01:00
commit aabb6aef23
1 changed files with 11 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
book/installation-and-setup/jupyter-book-setup.md
View file

@ -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 <path-to-book> --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).