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
49 changes: 49 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Docs

on:
pull_request:
paths:
- "docs/**"
- "kale/**"
- "pyproject.toml"
- "uv.lock"
- ".readthedocs.yaml"
- ".github/workflows/docs.yaml"
push:
branches:
- main
paths:
- "docs/**"
- "kale/**"
- "pyproject.toml"
- "uv.lock"
- ".readthedocs.yaml"
- ".github/workflows/docs.yaml"

jobs:
build:
name: Build documentation
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1

- name: Set up Python
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version: "3.11"

- name: Install uv
run: pip install uv

- name: Install docs dependencies
run: uv sync --extra docs

- name: Build Sphinx site
run: uv run sphinx-build -b html -W --keep-going docs/source docs/_build/html

- name: Upload built site
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
name: kale-docs-html
path: docs/_build/html
20 changes: 20 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Read the Docs configuration for the Kale documentation site.
# See https://docs.readthedocs.io/en/stable/config-file/v2.html
version: 2

build:
os: ubuntu-24.04
tools:
python: "3.11"
jobs:
post_create_environment:
- pip install uv
post_install:
- UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --extra docs

sphinx:
configuration: docs/source/conf.py
fail_on_warning: false

formats:
- htmlzip
16 changes: 16 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
clean clean-venv lock lock-upgrade check-uv \
jupyter jupyter-kfp watch-labextension \
docker-build docker-run \
docs docs-serve docs-clean \
release verify check-versions

UV := uv
Expand Down Expand Up @@ -186,6 +187,21 @@ jupyter-kfp: ## Start JupyterLab with KFP dev environment (run kfp-serve first!)
watch-labextension: ## Watch labextension for changes (run in separate terminal)
cd labextension && $(JLPM) watch

##@ Documentation

docs: ## Build the documentation site (HTML)
@printf "$(BLUE)Building documentation...\n$(NC)"
$(UV) sync --extra docs
$(UV) run sphinx-build -b html docs/source docs/_build/html
@printf "$(GREEN)Docs built: docs/_build/html/index.html\n$(NC)"

docs-serve: docs ## Build and serve the docs locally on port 8000
@printf "$(BLUE)Serving docs on http://localhost:8000\n$(NC)"
cd docs/_build/html && python3 -m http.server 8000

docs-clean: ## Remove built documentation
rm -rf docs/_build

##@ Release

check-versions: ## Verify backend and labextension versions match
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ Kale bridges this gap by providing a simple UI to define Kubeflow Pipelines
workflows directly from your JupyterLab interface, without the need to change a
single line of code.

📖 **Documentation:** <https://kale.kubeflow.org>

See the `Kale v2.0 Demo` video at the bottom of the `README` for more details.

Read more about Kale and how it works in this Medium post:
Expand Down
12 changes: 12 additions & 0 deletions docs/imgs/kale_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/imgs/quickstart-01-jupyterlab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/imgs/quickstart-02-kale-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/imgs/quickstart-03-cell-tags.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/imgs/quickstart-04-panel-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/imgs/quickstart-05-compile-run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/imgs/quickstart-06-kfp-run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading