Skip to content

Commit

Permalink
docs(tutorial): deploy jupyterlite
Browse files Browse the repository at this point in the history
  • Loading branch information
cpcloud committed Apr 18, 2024
1 parent 4ad734d commit 09ef6a7
Show file tree
Hide file tree
Showing 8 changed files with 874 additions and 8 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -147,3 +147,7 @@ docs/**/.jupyter_cache
# quarto generated files
docs/posts-listing.json
docs/posts.feed-full-staged

# jupyterlite stuff
.jupyterlite.doit.db
content
2 changes: 2 additions & 0 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ website:
- posts.qmd
- release_notes.qmd
- sidebar:contribute
- text: "Try Ibis live"
file: ./jupyterlite/index.html

sidebar:
- id: ""
Expand Down
4 changes: 3 additions & 1 deletion docs/tutorials/getting_started.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ This is a quick tour of some basic commands and usage patterns, just to get your

## Install Ibis

{{< include ../_tabsets/install_default.qmd >}}
```bash
pip install 'ibis-framework[duckdb]'
```

## Create a database file

Expand Down
2 changes: 1 addition & 1 deletion flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@
ibis311 = mkDevShell pkgs.ibisDevEnv311;
ibis312 = mkDevShell pkgs.ibisDevEnv312;

default = ibis312;
default = ibis311;

preCommit = pkgs.mkShell {
name = "preCommit";
Expand Down
11 changes: 11 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -162,17 +162,28 @@ docs-preview:

# regen api and preview docs
docs-api-preview:
just build-jupyterlite
just docs-apigen --verbose
quarto preview docs

# deploy docs to netlify
docs-deploy:
quarto publish --no-prompt --no-browser --no-render netlify docs

# build jupyterlite deployment
build-jupyterlite *args:
#!/usr/bin/env bash
mkdir -p content
python -c "import sys; print('.'.join(map(str, sys.version_info[:2])))" > content/runtime.txt
quarto convert docs/tutorials/getting_started.qmd --output content/getting_started.ipynb
mkdir -p docs/_output/jupyterlite
jupyter lite build --output-dir docs/_output/jupyterlite --contents content {{ args }}
# run the entire docs build pipeline
docs-build-all:
just docs-apigen --verbose
just docs-render
just build-jupyterlite
just checklinks docs/_output --offline --no-progress

# open chat
Expand Down
Loading

0 comments on commit 09ef6a7

Please sign in to comment.