Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
# Contributing to SIMPLE-Py

Contributions are welcome! This project is a workshop book built with Jupyter Book and accompanied by Marp slides.
Contributions are welcome! This project is a workshop book built with [MyST](https://mystmd.org/) and accompanied by Marp slides.

## Setup

### Prerequisites

- [uv](https://docs.astral.sh/uv/) (for building the book)
- [Node.js](https://nodejs.org/) (for building the slides)
- [Node.js](https://nodejs.org/) (for building the book and slides)
- [prek](https://github.com/j178/prek) (for linting)

## Building the book

```bash
uvx jupyter-book build --html
npx mystmd build --html
```

The output is placed in `_build/html/`.
Expand Down
8 changes: 3 additions & 5 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,14 @@ jobs:
steps:
- uses: actions/checkout@v6

- uses: astral-sh/setup-uv@v8.1.0

- name: Build the book
run: uvx jupyter-book build --html
run: npx mystmd@latest build --html
env:
BASE_URL: /SIMPLE-Py

- uses: actions/upload-artifact@v7
with:
name: jupyterbook
name: book
path: _build/html/*

build-slides:
Expand Down Expand Up @@ -59,7 +57,7 @@ jobs:

- uses: actions/download-artifact@v8
with:
name: jupyterbook
name: book
path: public

- uses: actions/download-artifact@v8
Expand Down
2 changes: 1 addition & 1 deletion myst.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ project:
keywords: [Python, compiled, packaging, C++, Rust, publishing]
authors: [Henry Schreiner]
github: https://github.com/scikit-build/SIMPLE-Py
# To autogenerate a Table of Contents, run "jupyter book init --write-toc"
# To autogenerate a Table of Contents, run "npx mystmd init --write-toc"
toc:
# Auto-generated by `myst init --write-toc`
- file: README.md
Expand Down