Skip to content

Commit 4e5c209

Browse files
chenkianweechenkianwee
committed
jupyter book 2
1 parent d7f863f commit 4e5c209

5 files changed

Lines changed: 101 additions & 1 deletion

File tree

‎.github/workflows/deploy.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# This file was created automatically with `jupyter-book init --gh-pages` 🪄 💚
2+
# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
3+
4+
name: Jupyter Book (via myst) GitHub Pages Deploy
5+
on:
6+
push:
7+
# Runs on pushes targeting the default branch
8+
branches: [main]
9+
env:
10+
# `BASE_URL` determines, relative to the root of the domain, the URL that your site is served from.
11+
# E.g., if your site lives at `https://mydomain.org/myproject`, set `BASE_URL=/myproject`.
12+
# If, instead, your site lives at the root of the domain, at `https://mydomain.org`, set `BASE_URL=''`.
13+
BASE_URL: /${{ github.event.repository.name }}
14+
15+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
16+
permissions:
17+
contents: read
18+
pages: write
19+
id-token: write
20+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
21+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
22+
concurrency:
23+
group: 'pages'
24+
cancel-in-progress: false
25+
jobs:
26+
deploy:
27+
environment:
28+
name: github-pages
29+
url: ${{ steps.deployment.outputs.page_url }}
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/checkout@v4
33+
- name: Setup Pages
34+
uses: actions/configure-pages@v3
35+
- uses: actions/setup-node@v4
36+
with:
37+
node-version: 18.x
38+
- name: Install Jupyter Book (via myst)
39+
run: npm install -g jupyter-book
40+
- name: Build HTML Assets
41+
working-directory: ./arch134b_workshops
42+
run: jupyter-book build --html
43+
- name: Upload artifact
44+
uses: actions/upload-pages-artifact@v3
45+
with:
46+
path: 'arch134b_workshops/_build/html'
47+
- name: Deploy to GitHub Pages
48+
id: deployment
49+
uses: actions/deploy-pages@v4

arch134b_workshops/_config.yml renamed to arch134b_workshops/._config.yml.bak

File renamed without changes.

arch134b_workshops/_toc.yml renamed to arch134b_workshops/._toc.yml.bak

File renamed without changes.

‎arch134b_workshops/docs/07_shoebox_flrspace.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Shoebox Model Using only OpenStudio and its Geometry Editor FloorspaceJS
22

3-
This tutorial is similar to the previous tutorial {doc}`Shoebox Tutorial <02_shoebox>`, the difference is we will be building the 3D model within OpenStudio.
3+
This tutorial is similar to the previous tutorial [](Shoebox Tutorial <02_shoebox>), the difference is we will be building the 3D model within OpenStudio.
44

55
- First, install OpenStudio Application==1.9.0 <a href="https://github.com/openstudiocoalition/OpenStudioApplication/releases/tag/v1.9.0" target="_blank">here</a>.
66

‎arch134b_workshops/myst.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
version: 1
2+
project:
3+
title: Arch134b workshops
4+
authors:
5+
- name: Kian Wee Chen
6+
copyright: '2024'
7+
github: chenkianwee/pbad
8+
exports:
9+
- format: pdf
10+
template: plain_latex_book
11+
output: exports/book.pdf
12+
toc:
13+
- file: docs/intro.md
14+
- title: Tutorials
15+
children:
16+
- file: docs/01_climate.md
17+
children:
18+
- file: docs/01_1_climate_p1.md
19+
- file: docs/01_2_climate_p2.md
20+
- file: docs/02_shoebox.md
21+
children:
22+
- file: docs/02_1_shoebox_p1.md
23+
- file: docs/02_2_shoebox_p2.md
24+
- file: docs/02_3_shoebox_p3.md
25+
- file: docs/02_4_shoebox_p4.md
26+
- file: docs/02_5_shoebox_p5.md
27+
- file: docs/07_shoebox_flrspace.md
28+
children:
29+
- file: docs/07_1_shoebox_flrspace_p1.md
30+
- file: docs/07_2_shoebox_flrspace_p2.md
31+
- file: docs/07_3_shoebox_flrspace_p3.md
32+
- file: docs/03_cmf.md
33+
children:
34+
- file: docs/03_1_cmf_p1.md
35+
- file: docs/03_2_cmf_p2.md
36+
- file: docs/04_psvdgn.md
37+
children:
38+
- file: docs/04_1_psvdgn_p1.md
39+
- file: docs/04_2_psvdgn_p2.md
40+
- file: docs/05_hvac.md
41+
children:
42+
- file: docs/05_1_hvac_p1.md
43+
- file: docs/05_2_hvac_p2.md
44+
- file: docs/06_spec_hvac.md
45+
children:
46+
- file: docs/06_1_spec_hvac_p1.md
47+
- file: docs/06_2_spec_hvac_p2.md
48+
site:
49+
options:
50+
folders: true
51+
template: book-theme

0 commit comments

Comments
 (0)