Skip to content

Commit cb2b2e0

Browse files
committed
Downgrade jupyter book to v1
1 parent 2859df5 commit cb2b2e0

3 files changed

Lines changed: 7 additions & 19 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
# Build the book
4040
- name: Build the book
4141
run: |
42-
jupyter-book build .
42+
jupyter-book build --all .
4343
4444
# https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow
4545

publishing.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ And you will need read and write access to [the Github repository](https://githu
1717
cd data-exploration
1818
```
1919
20-
2. Install Jupyter Book
20+
2. Install Jupyter Book - Version 1 is required, Version 2 has breaking changes; 1.0.4 is the last stable V1
2121
2222
```
23-
pip install jupyter-book
23+
pip install "jupyter-book==1.0.4"
2424
```
2525
2626
3. Create or update your Jupyter Notebooks locally using your favorite notebook editor.
2727
28-
4. Once you made your changes, now you can build the Jupyter Notebook HTML
28+
4. Once you made your changes, now you can build the Jupyter Notebook HTML locally to see what it looks like
2929
3030
```
3131
jupyter-book build .
@@ -41,18 +41,6 @@ And you will need read and write access to [the Github repository](https://githu
4141
4242
5. Once built, you should be able to paste the file path (e.g. `file://path/to/data-exploration/_build/html/index.html`) displayed in the output into your browser bar to preview it. Make any changes necessary and re-run steps 3 and 4.
4343
44-
6. Once you are ready to publish, you will need to add an empty file called `.nojekyll` to the folder `./_build/html/`. This will tell Github not to interpret this as a Jekyll site.
44+
6. Once you are ready to publish, simply push or merge your changes into the `master` branch. This will trigger a re-build on Github Pages.
4545
46-
Then commit and push your changes to the main branch
47-
48-
```
49-
git push origin master
50-
```
51-
52-
And then push the generated HTML subfolder to the gh-site branch
53-
54-
```
55-
git subtree push --prefix _build/html origin gh-site
56-
```
57-
58-
This should trigger an automatic re-build of the changed Github Pages webpages. You should be able to see the status of those builds in the ["Actions"](https://github.com/LibraryOfCongress/data-exploration/actions) section of the repository. And once deployed, view the final result on [Github Pages](https://LibraryOfCongress.github.io/data-exploration/).
46+
You should be able to see the status of this build in the ["Actions"](https://github.com/LibraryOfCongress/data-exploration/actions) section of the repository. And once deployed, view the final result on [Github Pages](https://LibraryOfCongress.github.io/data-exploration/).

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
jupyter-book
1+
jupyter-book == 1.0.4

0 commit comments

Comments
 (0)