diff --git a/book/installation-and-setup/figures/Terminal.PNG b/book/installation-and-setup/figures/Terminal.PNG new file mode 100644 index 0000000..d015e08 Binary files /dev/null and b/book/installation-and-setup/figures/Terminal.PNG differ diff --git a/book/installation-and-setup/jupyter-book-setup.md b/book/installation-and-setup/jupyter-book-setup.md index 1c98a0b..feab159 100644 --- a/book/installation-and-setup/jupyter-book-setup.md +++ b/book/installation-and-setup/jupyter-book-setup.md @@ -5,15 +5,15 @@ This page is useful for user type 5. ``` -Jupyter book is a regular Python package which converts our content into a website. It's part of all of the `requirements.txt` files for a book repository. At TeachBooks we developed a Python package called `teachbooks` which takes over the jupyter-book features and adds [additional features](/book/features/overview.md). One of those additional features is the workflow to GitHub Pages. +Jupyter book is a regular Python package which converts our content into a website. It's part of all of the `requirements.txt` files for a book repository. At TeachBooks we developed a Python package called `teachbooks` which takes over the these features and adds [additional features](/book/features/overview.md). One of those additional features, for example, is the workflow to GitHub Pages. + +Concretely, this means that the teachbooks package can be used to replace the Jupyter book package when calling these features. You could think of it as `jupyter-book` being a dependency of `teachbooks`. ```{admonition} Note :class: tip -Note that you should specify the package `teachbooks` in the `requirements.txt` files in your book repository. +Don't forget to add the package `teachbooks` in the `requirements.txt` files in your book repository and to have it installed in your working environment (`pip install teachbooks`). ``` -Concretely, this means that the teachbooks package can be used to replace the jupyter-book package when calling jupyter-book features. You could think of it as `jupyter-book` being a dependency of `teachbooks`. - ## Build a book As soon as you've installed your book environment with jupyter-book you can build your book locally. The official Jupyter book documentation is quite extensive. Only two notes: first navigate to the directory where your book is to leave out the `path-to-book` and use `--all` whenever building a book to make sure the table of contents fully updates: @@ -21,14 +21,23 @@ As soon as you've installed your book environment with jupyter-book you can buil ``` teachbooks build --all ``` -Or alternatively: +Alternatively: ``` 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). +Once the build process is completed successfully, you will see the file location in your terminal output. Your terminal will look something like this. Simply open this in the browser (you may have to copy/paste). + +```{figure} ../figures/Terminal.PNG +--- +width: 80% +name: terminal +align: center +--- +Terminal +``` ```{admonition} Tip :class: tip, dropdown