Skip to content

[DOC] Add Sphinx Doc Build Framework to Sedona Python - #2064

Merged
jiayuasu merged 4 commits into
apache:masterfrom
zhangfengcdt:doc.add.framework
Jul 7, 2025
Merged

jiayuasu merged 4 commits into
apache:masterfrom
zhangfengcdt:doc.add.framework

Conversation

@zhangfengcdt

Copy link
Copy Markdown
Member

Did you read the Contributor Guide?

Is this PR related to a ticket?

  • No:
    • this is a documentation update. The PR name follows the format [DOCS] my subject

What 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?

  • Yes, I have updated the documentation.

@zhangfengcdt

Copy link
Copy Markdown
Member Author

screenshot of the generated doc:

Screenshot 2025-07-05 at 9 16 48 AM

@jiayuasu
jiayuasu requested a review from Copilot July 7, 2025 05:46

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 .rst files under python/sedona/doc
  • Updates .gitignore and 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 documentation does not match the project name in conf.py (Apache Sedona Python). Consider renaming this header to Apache Sedona Python Documentation for consistency.
sedona-python documentation

Comment thread python/.gitignore
/dist/
/sedona/utils/*.so
__pycache__
/sedona/doc/_build/

Copilot AI Jul 7, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/

Copilot uses AI. Check for mistakes.
@jiayuasu

jiayuasu commented Jul 7, 2025

Copy link
Copy Markdown
Member

Great work, Feng. I will merge this first and make some modification on it!

@jiayuasu jiayuasu added this to the sedona-1.8.0 milestone Jul 7, 2025
@jiayuasu
jiayuasu merged commit 21ff360 into apache:master 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants