You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: publishing.md
+5-17Lines changed: 5 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,15 +17,15 @@ And you will need read and write access to [the Github repository](https://githu
17
17
cd data-exploration
18
18
```
19
19
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
21
21
22
22
```
23
-
pip install jupyter-book
23
+
pip install "jupyter-book==1.0.4"
24
24
```
25
25
26
26
3. Create or update your Jupyter Notebooks locally using your favorite notebook editor.
27
27
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
29
29
30
30
```
31
31
jupyter-book build .
@@ -41,18 +41,6 @@ And you will need read and write access to [the Github repository](https://githu
41
41
42
42
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.
43
43
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.
45
45
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
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/).
0 commit comments