Repository navigation
[DOC] Add Sphinx Doc Build Framework to Sedona Python - #2064
Merged
Merged
Conversation
Member
Author
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a Sphinx-based documentation framework for the Sedona Python packages, including configuration, build scripts, and a full set of reStructuredText skeletons for every module and subpackage.
- Adds Sphinx config, Makefile, and batch script to drive the documentation build
- Creates an
index.rst,modules.rst, and dozens of per-package.rstfiles underpython/sedona/doc - Updates
.gitignoreand adds a README with local build instructions
Reviewed Changes
Copilot reviewed 46 out of 46 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| python/sedona/doc/conf.py | Sphinx configuration (project info, extensions, paths) |
| python/sedona/doc/index.rst | Root toctree and introduction for Sedona Python |
| python/sedona/doc/modules.rst | Placeholder modules toctree |
| python/sedona/doc/Makefile | Unix make targets for building docs |
| python/sedona/doc/make.bat | Windows batch script for Sphinx |
| python/sedona/README.md | Instructions to build the docs locally |
| python/.gitignore | Ignoring doc build artifacts |
| python/sedona/doc/*.rst | Auto-module stubs for all packages and subpackages |
Comments suppressed due to low confidence (1)
python/sedona/doc/index.rst:6
- [nitpick] The title
sedona-python documentationdoes not match the project name inconf.py(Apache Sedona Python). Consider renaming this header toApache Sedona Python Documentationfor consistency.
sedona-python documentation
| /dist/ | ||
| /sedona/utils/*.so | ||
| __pycache__ | ||
| /sedona/doc/_build/ |
There was a problem hiding this comment.
The ignore rule targets /sedona/doc/_build/ but the actual build output path is python/sedona/doc/_build/. You should update this entry to sedona/doc/_build/ or python/sedona/doc/_build/ so that the Sphinx build output is properly ignored.
Suggested change
| /sedona/doc/_build/ | |
| /python/sedona/doc/_build/ |
Member
|
Great work, Feng. I will merge this first and make some modification on it! |
jiayuasu
approved these changes
Jul 7, 2025
Kontinuation
pushed a commit
to Kontinuation/sedona
that referenced
this pull request
Jan 21, 2026
* [DOC] Add Sphinx Doc Build Framework to Sedona Python * add style and readme * fix pre-commit lint errors
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.

Did you read the Contributor Guide?
Is this PR related to a ticket?
[DOCS] my subjectWhat changes were proposed in this PR?
This PR add python document framework based on Sphinx packages.
How was this patch tested?
NA
Did this PR include necessary documentation updates?