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]>
2.7 KiB
2.7 KiB
Kubeflow Spark Operator Documentation
This directory contains the source for the Kubeflow Spark Operator documentation website, built with Sphinx, the Furo theme, and MyST Markdown. It is designed to be hosted on Read the Docs.
Prerequisites
- uv (manages Python and all dependencies)
uv handles the Python toolchain and the documentation dependencies declared in
pyproject.toml (the docs dependency group, pinned in
uv.lock). There is no need to create a virtual environment by hand.
Building locally
From the repository root:
make docs # build static HTML into docs/website/_build/html
make docs-test # strict build (warnings treated as errors)
make docs-serve # build and serve with live reload at http://localhost:8000
make docs-linkcheck # validate external links
make docs-clean # remove build artifacts
Or run uv directly from this directory:
cd docs/website
uv run --group docs sphinx-build -b html . _build/html
uv run --group docs sphinx-autobuild . _build/html --port 8000 # live reload
The generated site is written to docs/website/_build/html. Open
docs/website/_build/html/index.html in a browser, or use make docs-serve for
live reload.
Layout
docs/website/
├── pyproject.toml # Python deps (uv "docs" group) + uv.lock
├── conf.py # Sphinx configuration
├── index.rst # Landing page (custom HTML hero)
├── Makefile # html / test / serve / linkcheck / clean targets
├── _ext/kubeflow_topnav/ # Sphinx extension: top navigation bar
├── _static/
│ ├── css/custom.css # Kubeflow theme + landing page styles (light & dark)
│ ├── img/ # logos, architecture diagram, CNCF mark
│ └── js/ # external-links, sidebar-toggle, landing-page, etc.
├── overview/ # Overview
├── getting-started/ # Installation & first SparkApplication
├── user-guide/ # In-depth user guides
├── performance/ # Benchmarking
├── reference/ # API reference
└── contributor-guide/ # Developer guide
Read the Docs
The build is configured by .readthedocs.yaml at the
repository root, which runs uv sync and uv run sphinx-build against
docs/website.
Documentation content is distributed under CC BY 4.0.