Skip to content

Commit 0eaa3ec

Browse files
committed
add back
1 parent d017475 commit 0eaa3ec

4 files changed

Lines changed: 18 additions & 7 deletions

File tree

.github/workflows/python-ci-docs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ jobs:
4141
python-version: 3.12
4242
- name: Install UV
4343
uses: astral-sh/setup-uv@v7
44+
- name: Install
45+
run: make docs-install
4446
- name: Build docs
4547
run: make docs-build
4648
- name: Run linters

.github/workflows/python-release-docs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ jobs:
3636
python-version: ${{ matrix.python }}
3737
- name: Install UV
3838
uses: astral-sh/setup-uv@v7
39+
- name: Install docs
40+
run: make docs-install
3941
- name: Build docs
4042
run: make docs-build
4143
- name: Copy

Makefile

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ test: ## Run all unit tests (excluding integration)
9898

9999
test-integration: test-integration-setup test-integration-exec test-integration-cleanup ## Run integration tests
100100

101-
test-integration-setup: ## Start Docker services for integration tests
101+
test-integration-setup: install ## Start Docker services for integration tests
102102
docker compose -f dev/docker-compose-integration.yml kill
103103
docker compose -f dev/docker-compose-integration.yml rm -f
104104
docker compose -f dev/docker-compose-integration.yml up -d --build --wait
@@ -145,23 +145,29 @@ coverage-report: ## Combine and report coverage
145145

146146
##@ Documentation
147147

148+
docs-install: ## Install docs dependencies (included in default groups)
149+
uv sync $(PYTHON_ARG) --group docs
150+
148151
docs-serve: ## Serve local docs preview (hot reload)
149-
uv run $(PYTHON_ARG) --group docs mkdocs serve -f mkdocs/mkdocs.yml --livereload
152+
uv run $(PYTHON_ARG) mkdocs serve -f mkdocs/mkdocs.yml --livereload
150153

151154
docs-build: ## Build the static documentation site
152-
uv run $(PYTHON_ARG) --group docs mkdocs build -f mkdocs/mkdocs.yml --strict
155+
uv run $(PYTHON_ARG) mkdocs build -f mkdocs/mkdocs.yml --strict
153156

154157
# ========================
155158
# Experimentation
156159
# ========================
157160

158161
##@ Experimentation
159162

160-
notebook: ## Launch notebook for experimentation
161-
uv run $(PYTHON_ARG) --all-extras --group notebook jupyter lab --notebook-dir=notebooks
163+
notebook-install: ## Install notebook dependencies
164+
uv sync $(PYTHON_ARG) --all-extras --group notebook
165+
166+
notebook: notebook-install ## Launch notebook for experimentation
167+
uv run jupyter lab --notebook-dir=notebooks
162168

163-
notebook-infra: test-integration-setup ## Launch notebook with integration test infra (Spark, Iceberg Rest Catalog, object storage, etc.)
164-
uv run $(PYTHON_ARG) --all-extras --group notebook jupyter lab --notebook-dir=notebooks
169+
notebook-infra: notebook-install test-integration-setup ## Launch notebook with integration test infra (Spark, Iceberg Rest Catalog, object storage, etc.)
170+
uv run jupyter lab --notebook-dir=notebooks
165171

166172
# ===================
167173
# Project Maintenance

mkdocs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ The pyiceberg docs are stored in `docs/`.
2222
## Running docs locally
2323

2424
```sh
25+
make docs-install
2526
make docs-serve
2627
```

0 commit comments

Comments
 (0)