Skip to content

[DOCS] Improve Makefile by Using requirements-docs.txt for Documentation Dependencies #1808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
jiayuasu merged 5 commits into from
Feb 12, 2025
Merged

[DOCS] Improve Makefile by Using requirements-docs.txt for Documentation Dependencies #1808

jiayuasu merged 5 commits into from
Feb 12, 2025

Conversation

@BaseMax
Copy link
Contributor

@BaseMax BaseMax commented Feb 12, 2025

This update refactors the docsinstall target in the Makefile to use a predefined requirements-docs.txt file instead of dynamically creating it. This ensures better dependency management, simplifies maintenance, and aligns with best practices for handling Python package installations.

@BaseMax BaseMax requested a review from jiayuasu as a code owner February 12, 2025 20:18
@github-actions github-actions bot added the root label Feb 12, 2025
@jbampton jbampton self-assigned this Feb 12, 2025
@jbampton jbampton added improvement python Pull requests that update Python code labels Feb 12, 2025
jbampton
jbampton approved these changes Feb 12, 2025
View reviewed changes
Copy link
Member

@jbampton jbampton left a comment

Choose a reason for hiding this comment

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

Tested locally. Ran the Makefile phony targets. Seems to work.

Thanks 👍

@jiayuasu jiayuasu changed the title Improve Makefile by Using requirements-docs.txt for Documentation Dependencies [DOCS] Improve Makefile by Using requirements-docs.txt for Documentation Dependencies Feb 12, 2025
@jiayuasu jiayuasu merged commit ea4ca69 into apache:master Feb 12, 2025
3 checks passed
Kontinuation added a commit to Kontinuation/sedona that referenced this pull request Jan 21, 2026
@jiayuasu @jbampton
@BaseMax @MrPowers @zhangfengcdt @ruanqizhen @Imbruced @paleolimbot @dependabot @Kontinuation
Bring OSS Sedona updates to the master branch (March 06 2025) (apache…
8ff29e9 
…#386)

* [DOCS] Run Python black on Markdown code blocks (apache#1797)

* [CI] pre-commit autoupdate; configure `bandit[toml]` dependency (apache#1799)

Under bandit settings it lists the additional dependency for toml files

https://bandit.readthedocs.io/en/latest/config.html#bandit-settings

* [DOCS] Fix spelling (apache#1800)

* [CI] pre-commit: auto add license headers to `.c` and `.h` files (apache#1802)

* [CI] Update asf.yml (apache#1803)

* Commit

* Add john too

* [DOCS] Add Pranav Toggi to the Committers list (apache#1806)

* .asf.yaml: remove committer jbampton from collaborators (apache#1805)

https://github.com/apache/infrastructure-asfyaml?tab=readme-ov-file#assigning-the-github-triage-role-to-external-collaborators

"Projects may assign external (non-committer) collaborators the triage role for their repository."

* [DOCS] Improve Makefile by Using requirements-docs.txt for Documentation Dependencies (apache#1808)

* Update Makefile

* Create requirements-docs.txt

* Update Makefile

* Update Makefile

* Update Makefile

* [CI] pre-commit: auto add license check for Java files (apache#1807)

* [DOCS] Fix spelling (apache#1804)

* [DOCS] Add geojson docs (apache#1814)

* use dashes not underscores

* fix whitespace

* update based on pr comments

* [DOCS] Add Matomo to Sedona website (apache#1820)

* [DOC] Update ST_KNN documentation for left inner join support and inner kNN join details (apache#1821)

* [DOCS] Correct the document for ST_MakeValid (apache#1822)

* [DOCS] add geoparquet docs page (apache#1818)

* add geoparquet docs page

* use linter

* centralize content on geoparquet page

* lint file

---------

Co-authored-by: Jia Yu <[email protected]>

* [DOCS] add docs on csv files (apache#1824)

* [DOCS] add spatial joins (apache#1829)

* [DOCS] add spatial joins page

* add alt text to images

* update spatial joins based on pr comments

* Update docs/tutorial/concepts/spatial-joins.md

---------

Co-authored-by: Jia Yu <[email protected]>

* Add several frequent contributors (apache#1833)

* [SEDONA-714] Add geopandas to spark arrow conversion. (apache#1825)

* SEDONA-714 Add geopandas to spark arrow conversion.

* SEDONA-714 Add geopandas to spark arrow conversion.

* SEDONA-714 Add geopandas to spark arrow conversion.

* SEDONA-714 Add geopandas to spark arrow conversion.

* SEDONA-714 Add geopandas to spark arrow conversion.

* Update python/sedona/utils/geoarrow.py

Co-authored-by: Dewey Dunnington <[email protected]>

* SEDONA-714 Add geopandas to spark arrow conversion.

* SEDONA-714 Add docs.

* SEDONA-714 Add docs.

---------

Co-authored-by: Dewey Dunnington <[email protected]>

* [SEDONA-713] add OSM PBF reader (apache#1823)

* Add OSM PBF reader.

Add documentation.

Add documentation.

Add documentation.

Add documentation.

Add documentation.

SEDONA-713 moving to common.

* SEDONA-713 Add docs.

* SEDONA-713 Add docs.

* SEDONA-713 Add docs.

* SEDONA-714 Add docs.

* [DOCS] add geopackage docs (apache#1835)

* [DOCS] add shapefiles documentation page (apache#1837)

* build(deps): bump com.google.protobuf:protobuf-java in /shade-proto (apache#1834)

Bumps [com.google.protobuf:protobuf-java](https://github.com/protocolbuffers/protobuf) from 4.28.0 to 4.28.2.
- [Release notes](https://github.com/protocolbuffers/protobuf/releases)
- [Changelog](https://github.com/protocolbuffers/protobuf/blob/main/protobuf_release.bzl)
- [Commits](https://github.com/protocolbuffers/protobuf/commits)

---
updated-dependencies:
- dependency-name: com.google.protobuf:protobuf-java
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* [SEDONA-717] Fix `dataframe_to_arrow()` for zero-row results (apache#1840)

* fix zero-row case

* typo

* fix lint

* [SEDONA-718] Auto Detect geometry column in GeoJSON writer (apache#1841)

* [SEDONA-719] Support reading Shapefile with Z/M ordinates (apache#1842)

* [DOCS] Fix lint issue

* Fix shade-proto pom file name

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: John Bampton <[email protected]>
Co-authored-by: Max Base <[email protected]>
Co-authored-by: Matthew Powers <[email protected]>
Co-authored-by: Feng Zhang <[email protected]>
Co-authored-by: ruanqizhen <[email protected]>
Co-authored-by: Paweł Tokaj <[email protected]>
Co-authored-by: Dewey Dunnington <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Kristin Cowalcijk <[email protected]>
Kontinuation pushed a commit to Kontinuation/sedona that referenced this pull request Jan 21, 2026
@BaseMax @jiayuasu
[DOCS] Improve Makefile by Using requirements-docs.txt for Documentat…
8209f81 
…ion Dependencies (apache#1808)

* Update Makefile

* Create requirements-docs.txt

* Update Makefile

* Update Makefile

* Update Makefile
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jbampton jbampton jbampton approved these changes

@jiayuasu jiayuasu jiayuasu approved these changes

Assignees

@jbampton jbampton

Labels

improvement python Pull requests that update Python code root

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@BaseMax @jbampton @jiayuasu