docs: add Sphinx documentation site with user and contributor guides#24
Merged
Conversation
# Conflicts: # .gitignore # CONTRIBUTING.md # README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a Sphinx-based documentation site under
docs/, mirroring the layout used by sibling DataFusion subprojects (datafusion,datafusion-comet,datafusion-python).What changed
docs/directory with Sphinx config (source/conf.py), MyST parser for Markdown, pydata-sphinx-theme, andbuild.sh/Makefile/make.batscaffolding.docs/source/index.md) with the Quickstart example and three toctrees (Links, User Guide, Contributor Guide).docs/source/user-guide/): installation, quickstart walkthrough, SessionContext lifecycle and threading, DataFrame + SQL API, Parquet ingestion withParquetReadOptions, project status checklists.docs/source/contributor-guide/): build & test workflow, code style (spotless, cargo fmt/clippy, license headers), DataFusion / protobuf version bump recipe, releasing placeholder.README.mdto a slim Quickstart + pointers into the docs site.CONTRIBUTING.mdpointing to the contributor guide..gitignoreexcludesdocs/build/anddocs/venv/.Build
build.shuses-Wso any future Sphinx warning fails the build. Site builds cleanly today with zero warnings.Not in this PR