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: docs/README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,10 @@ ALLCools documentation
8
8
9
9
If you'd like to develop on and build the ALLCools book, you should:
10
10
11
-
-Clone this repository and run
12
-
-Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)
13
-
-(Recommended) Remove the existing `ALLCools/_build/` directory
14
-
-Run `jupyter-book build ALLCools/`
11
+
- Clone this repository and run
12
+
- Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)
13
+
- (Recommended) Remove the existing `ALLCools/_build/` directory
14
+
- Run `jupyter-book build ALLCools/`
15
15
16
16
A fully-rendered HTML version of the book will be built in `ALLCools/_build/html/`.
17
17
@@ -21,8 +21,8 @@ The html version of the book is hosted on the `gh-pages` branch of this repo. A
21
21
22
22
If you wish to disable this automation, you may remove the GitHub actions workflow and build the book manually by:
23
23
24
-
-Navigating to your local build; and running,
25
-
-`ghp-import -n -p -f ALLCools/_build/html`
24
+
- Navigating to your local build; and running,
25
+
-`ghp-import -n -p -f ALLCools/_build/html`
26
26
27
27
This will automatically push your build to the `gh-pages` branch. More information on this hosting process can be found [here](https://jupyterbook.org/publish/gh-pages.html#manually-host-your-book-with-github-pages).
0 commit comments