Skip to content

Commit 2e5cfcd

Browse files
authored
Update HowTo_JupyterBook.md
Signed-off-by: Mackenzie Mathis <[email protected]>
1 parent d8ad96b commit 2e5cfcd

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/HowTo_JupyterBook.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# What is Jupyterbook?
22

3-
https://jupyterbook.org/en/stable/intro.html
3+
We use JupyterBook for documentation and sharing computational notebooks. [Here](https://www.nature.com/articles/d41586-018-07196-1) is a nice article for motivation.
4+
5+
📑 The documentation: https://jupyterbook.org/en/stable/intro.html
46

57

68
## Quick start
@@ -9,7 +11,7 @@ https://jupyterbook.org/en/stable/intro.html
911
jupyter-book create --cookiecutter YourClonedRepo/
1012
```
1113

12-
### Build from the template provided
14+
## OR Build from the template provided in this Repo!
1315

1416
(1) Use and adapt the two template files (_toc.yml, _config.yml) to your main code base, and be sure to keep the `docs` structure, i.e.,
1517
```
@@ -26,11 +28,17 @@ jupyter-book create --cookiecutter YourClonedRepo/
2628

2729
TL;DR in the main repo run:
2830
```python
29-
jupyter-book build .
31+
jupyter-book build .
3032
```
3133
and then follow terminal prompt (check errors, etc)- viola!
3234

3335

36+
## Deployment:
37+
3438
To then deploy the book live, see: https://jupyterbook.org/en/stable/publish/gh-pages.html#automatically-host-your-book-with-github-actions
3539

36-
In short, you will set up a git action to deploy to a new branch (that you never merge) called `gh-pages`
40+
In short, Go to Settings > Pages and set up anaction to deploy to a new branch (that you never merge) called `gh-pages`:
41+
42+
![Screen Shot 2025-06-17 at 2 20 19 PM](https://github.com/user-attachments/assets/17d13802-6543-4859-ac09-7abbd491277d)
43+
44+

0 commit comments

Comments
 (0)