mirror of
https://github.com/hanzo-ml/spark-operator.git
synced 2026-10-30 20:39:07 +00:00
4879adacdb
* new local website docs Signed-off-by: vara-bonthu <[email protected]> * homepage UX: ribbon logo, architecture diagram, CNCF footer, code-block fixes Signed-off-by: vara-bonthu <[email protected]> * docs: favicon, social cards, image optimization, consistent paragraph sizing Signed-off-by: vara-bonthu <[email protected]> * Potential fix for pull request finding Signed-off-by: Vara Bonthu <[email protected]> * docs: address PR review feedback (brand link, storage guard, cron, typos) Signed-off-by: vara-bonthu <[email protected]> * docs: address PR review (spec.mode, jar typo, CSS @import order, external-link host check, brand-link fallback) + strict docs build gate Signed-off-by: vara-bonthu <[email protected]> * docs: embed Kubeflow Spark Operator intro video on homepage Signed-off-by: vara-bonthu <[email protected]> * docs: clarify homepage video is the CNCF KubeCon NA 2024 best-practices talk Signed-off-by: vara-bonthu <[email protected]> * docs: fix header logo opening homepage in a new tab (exclude brand link from external-link handling) Signed-off-by: vara-bonthu <[email protected]> * docs: fix header logo navigation and point Kubeflow.org links to kubeflow.org Signed-off-by: vara-bonthu <[email protected]> * ci: add documentation build and link-check workflow Signed-off-by: vara-bonthu <[email protected]> * ci(docs): make linkcheck non-blocking; fix broken links and ignore JS-rendered anchors Signed-off-by: vara-bonthu <[email protected]> * docs: fix benchmarking links (Data on EKS benchmark kit and contributor handle) Signed-off-by: vara-bonthu <[email protected]> * docs: refine homepage copy and add muted color accents to landing cards Signed-off-by: vara-bonthu <[email protected]> * docs: move website under docs/website and manage Python deps with uv - Move the Sphinx site from docs/ to docs/website/ - Replace requirements.txt with pyproject.toml (uv 'docs' group) and uv.lock - Build with uv in Read the Docs, the Makefile targets, and CI - Leave pre-existing docs/{api-docs,kustomize-installation,release}.md in place Signed-off-by: vara-bonthu <[email protected]> * docs: improve sidebar navigation readability and hierarchy Signed-off-by: vara-bonthu <[email protected]> --------- Signed-off-by: vara-bonthu <[email protected]> Signed-off-by: Vara Bonthu <[email protected]> Co-authored-by: Hanzo Dev <[email protected]>
53 lines
1.7 KiB
Makefile
53 lines
1.7 KiB
Makefile
# Makefile for Sphinx documentation
|
|
# Kubeflow Spark Operator Documentation System
|
|
#
|
|
# Python tooling is managed with uv. `uv run` automatically syncs the `docs`
|
|
# dependency group from pyproject.toml / uv.lock before running.
|
|
|
|
# You can set these variables from the command line.
|
|
SPHINXOPTS =
|
|
SPHINXBUILD = uv run --group docs sphinx-build
|
|
SOURCEDIR = .
|
|
BUILDDIR = _build
|
|
|
|
# Default target
|
|
.PHONY: help
|
|
help:
|
|
@echo "Kubeflow Spark Operator Documentation Build Targets:"
|
|
@echo " html Build HTML documentation"
|
|
@echo " test Strict build (warnings treated as errors)"
|
|
@echo " linkcheck Check all links in documentation"
|
|
@echo " clean Remove build artifacts"
|
|
@echo " serve Build and serve documentation locally with live reload"
|
|
|
|
.PHONY: html
|
|
html:
|
|
$(SPHINXBUILD) -b html $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
|
|
@echo
|
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
|
|
|
.PHONY: test
|
|
test:
|
|
@echo "Strict build — warnings are treated as errors."
|
|
$(SPHINXBUILD) -b html -W --keep-going $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
|
|
@echo
|
|
@echo "Docs build passed with no warnings."
|
|
|
|
.PHONY: linkcheck
|
|
linkcheck:
|
|
$(SPHINXBUILD) -b linkcheck $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/linkcheck
|
|
@echo
|
|
@echo "Link check complete. See $(BUILDDIR)/linkcheck/output.txt for results."
|
|
|
|
.PHONY: clean
|
|
clean:
|
|
rm -rf $(BUILDDIR)
|
|
@echo "Build artifacts removed."
|
|
|
|
.PHONY: serve
|
|
serve:
|
|
@echo "Starting live-reload documentation server on http://localhost:8000"
|
|
@echo "Documentation will auto-rebuild on file changes."
|
|
@echo "Press Ctrl+C to stop."
|
|
uv run --group docs sphinx-autobuild $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html --port 8000
|