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]>
27 lines
904 B
TOML
27 lines
904 B
TOML
[project]
|
|
name = "spark-operator-docs"
|
|
version = "0.0.0"
|
|
description = "Kubeflow Spark Operator documentation website"
|
|
requires-python = ">=3.12"
|
|
|
|
# The documentation website is built with Sphinx. Dependencies live in the
|
|
# `docs` group and are installed with `uv sync --group docs`.
|
|
[dependency-groups]
|
|
docs = [
|
|
"sphinx>=7.2.0,<8.0.0",
|
|
"furo>=2024.8.6",
|
|
"myst-parser>=3.0.0,<4.0.0",
|
|
"sphinxcontrib-mermaid>=0.9.0,<1.0.0",
|
|
"sphinx-copybutton>=0.5.2,<1.0.0",
|
|
"sphinx-design>=0.6.0,<1.0.0",
|
|
"sphinxext-opengraph>=0.9.0,<1.0.0",
|
|
# Live reload for local development. Pinned to the livereload/tornado-based
|
|
# release; newer (uvicorn/websocket) releases raise
|
|
# "Task ... attached to a different loop" on some Python versions.
|
|
"sphinx-autobuild==2021.3.14",
|
|
]
|
|
|
|
# This is a documentation-only project; uv should not try to build/install it.
|
|
[tool.uv]
|
|
package = false
|