Skip to content

updating local install instructions for new _toc.yaml format #1138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

updating local install instructions for new _toc.yaml format #1138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions book/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@ In order to build the book locally, you will need to do the following:

`pip install -r requirements.txt`

`pip install jupyter-book==0.10.2`

**Important:** Do not install jupyter-book 0.11 or later at this point, as there are breaking changes in how it handles the table of contents file we generate.
`pip install jupyter-book`

5. Copy files from precourse to `tutorials/`

Expand All @@ -58,11 +56,15 @@ In order to build the book locally, you will need to do the following:

where `arg` can take either `student` or `instructor` as a value.

This will use the modified tutorials/materials.yml to create the `_toc.yml` file in the book directory. It will also be responsible for creating any additional markdown files or modifying any tutorial notebooks specifically for book generation.
This will use the modified tutorials/materials.yml to create the `_toc.yml` file in the book directory. It will also be responsible for creating any additional markdown files or modifying any tutorial notebooks specifically for book generation.

8. Migrate Table of Contents to the new jupyter-book format:

`jupyter-book toc migrate book/_toc.yml -o book/_toc.yml`

**No changes created by this script should be committed to the repo.**

8. Build the book
9. Build the book

`jupyter-book build book`

Expand Down