-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathintro
More file actions
41 lines (23 loc) · 1.04 KB
/
intro
File metadata and controls
41 lines (23 loc) · 1.04 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# Introduction
This is the intro to the JupyterBook!
This is just a placeholder for you to document your package.
## Developer Guide
### 0. Edit your `config` and `toc` to your specs.
### 1. Set Organization-level Permissions (already done for SCENE)
Go to:
`Org Settings` → `Actions` → `General` → `Select the repo` → Check:
"Allow GitHub Actions to access the GITHUB_TOKEN with write permissions" must be enabled.
"Workflow permissions" must allow read and write by default, or per repo.
### 2. Deploy the Docs
First, this is done via the GitHub actions `publish-book.yml`.
To get a public `github.io` link, you must enable GitHub Pages.
Note, this only works for public repos, or if private, from paid org.
### Steps:
1. Go to your repo → **Settings** → **Pages**
2. Under **"Source"**, select:
* **Branch**: e.g., `main`
* **Folder**: `/_build/html`
3. Click **"Save"**
GitHub will deploy your book and show a link like:
`https://<username>.github.io/<repo>/`
Deployment may take a minute. Refresh the page to see the live link!