Skip to content

Commit c5abb49

Browse files
mfisher87RRosio
andcommitted
Init MyST site with GH Pages and RTD
Co-authored-by: Rosio <[email protected]>
1 parent abfef52 commit c5abb49

File tree

5 files changed

+83
-0
lines changed

5 files changed

+83
-0
lines changed
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# This file was created automatically with `myst init --gh-pages` 🪄 💚
2+
# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
3+
4+
name: 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 MyST
39+
run: npm install -g mystmd
40+
- name: Build HTML Assets
41+
run: myst build --html
42+
- name: Upload artifact
43+
uses: actions/upload-pages-artifact@v3
44+
with:
45+
path: './_build/html'
46+
- name: Deploy to GitHub Pages
47+
id: deployment
48+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
# pixi environments
22
.pixi/*
33
!.pixi/config.toml
4+
5+
# MyST build outputs
6+
_build

.readthedocs.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# For this project, we use ReadTheDocs only for Pull Request previews. GitHub
2+
# pages currently hosts the actual website.
3+
version: 2
4+
5+
6+
build:
7+
os: "ubuntu-lts-latest"
8+
9+
commands:
10+
- "asdf plugin add pixi"
11+
- "asdf install pixi latest"
12+
- "asdf global pixi latest"
13+
14+
- "pixi run render"
15+
- "mkdir --parents $READTHEDOCS_OUTPUT/html/"
16+
- "mv _build/html/* $READTHEDOCS_OUTPUT/html/."
17+
- "rm -rf _build" # RTD build fails if _build/html is detected :(

index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Jupyter Community Committee

myst.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# See docs at: https://mystmd.org/guide/frontmatter
2+
version: 1
3+
project:
4+
title: "Jupyter Community Committee"
5+
# description:
6+
# keywords: []
7+
# authors: []
8+
github: "https://github.com/jupyter/community"
9+
# To autogenerate a Table of Contents, run "myst init --write-toc"
10+
site:
11+
template: "book-theme"
12+
# options:
13+
# favicon: favicon.ico
14+
# logo: site_logo.png

0 commit comments

Comments
 (0)