This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sedona.git
The following commit(s) were added to refs/heads/master by this push:
new f3fcdf650a [CI] Add Python API Documentation to CI/CD Pipeline (#2195)
f3fcdf650a is described below
commit f3fcdf650a05d013715fd404584fd5f05e9a3142
Author: Feng Zhang <[email protected]>
AuthorDate: Tue Jul 29 22:08:25 2025 -0700
[CI] Add Python API Documentation to CI/CD Pipeline (#2195)
* [DOC] Add Python API Documentation to CI/CD Pipeline
This PR enhances the documentation build process by adding automated
Python API documentation
generation using Sphinx, following the same pattern as existing R
documentation generation.
* Installs Sphinx dependencies
---
.github/workflows/docs.yml | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 2925f6f5c1..532f553629 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -66,6 +66,16 @@ jobs:
any::pkgdown
working-directory: './R'
- run: Rscript -e 'pkgdown::build_site(pkg = "./R", preview = FALSE,
override = list(destination = "../docs/api/rdocs"))'
+ - name: Install Python documentation dependencies
+ run: pip install sphinx sphinx_rtd_theme
+ - name: Build Python API documentation with Sphinx
+ run: |
+ cd python/sedona/doc
+ make clean
+ make html
+ cd ../../..
+ mkdir -p docs/api/pydocs
+ cp -r python/sedona/doc/_build/html/* docs/api/pydocs/
- run: git config --global user.name = "GitHub Action"
- run: git config --global user.email = "[email protected]"
- run: mkdocs build
