Skip to content
This repository was archived by the owner on Jul 28, 2025. It is now read-only.

Update Documentation with Pydata Sphinx Theme, and more - #523

Merged
rapids-bot[bot] merged 9 commits into
rapidsai:branch-22.06from
isVoid:fea/pydata_sphinx
May 30, 2022
Merged

rapids-bot[bot] merged 9 commits into
rapidsai:branch-22.06from
isVoid:fea/pydata_sphinx

Conversation

@isVoid

@isVoid isVoid commented May 11, 2022

Copy link
Copy Markdown
Contributor

This PR closes #459 . It updates the sphinx theme with Pydata-sphinx-theme.

Besides this PR also:

  • Fixed all existing warnings emitted during rendering the doc
  • Added a new section: internals.rst to focus on discussing GeoArrow format. Shuffled around the docstrings for GeoArrowBuffer and make background description and API usage relatively independent, but all presented in the same page for shared context.
  • Minor improvement to from_geopandas docstring.

@isVoid
isVoid requested review from a team as code owners May 11, 2022 00:28
@github-actions github-actions Bot added conda Related to conda and conda configuration Python Related to Python code labels May 11, 2022
@isVoid isVoid added documentation doc Documentation 3 - Ready for Review Ready for review by team non-breaking Non-breaking change improvement Improvement / enhancement to an existing function and removed conda Related to conda and conda configuration Python Related to Python code doc Documentation labels May 11, 2022
@isVoid

isVoid commented May 11, 2022

Copy link
Copy Markdown
Contributor Author

Front page:
image

@harrism harrism left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for cleaning up the docs and updating to the new format @isVoid ! I have some edit suggestions for the docs while you are at it.

Comment thread docs/source/api_docs/geopandas_compatibility.rst Outdated
Comment thread docs/source/api_docs/geopandas_compatibility.rst
Comment thread docs/source/api_docs/gis.rst Outdated
Comment thread docs/source/api_docs/internals.rst Outdated
Comment thread docs/source/api_docs/internals.rst Outdated
Comment thread docs/source/api_docs/spatial_indexing.rst Outdated
Comment thread docs/source/api_docs/trajectory.rst Outdated
Comment thread docs/source/index.rst
Comment on lines +18 to +19
cuSpatial proposes a new GeoArrow format from the fruit of discussions
with the GeoPandas team. GeoArrow is a packed columnar data format

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

GeoArrow exists independently of cuSpatial. This makes it sound like we invented GeoArrow. I don't think this sentence belongs in our documentation. (CC @thomcom )

Suggested change
cuSpatial proposes a new GeoArrow format from the fruit of discussions
with the GeoPandas team. GeoArrow is a packed columnar data format
GeoArrow is a packed columnar data format

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.

That's fine. I had the first implementation, though GeoArrow diverged from my implementation a little as per the previous discussions. :D :D

Comment thread docs/source/index.rst Outdated
Comment thread python/cuspatial/cuspatial/core/interpolate.py Outdated

@ajschmidt8 ajschmidt8 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Approving ops-codeowner file changes

Co-authored-by: Mark Harris <mharris@nvidia.com>
@github-actions github-actions Bot added conda Related to conda and conda configuration Python Related to Python code labels May 11, 2022
@isVoid

isVoid commented May 12, 2022

Copy link
Copy Markdown
Contributor Author

Thanks to @ajschmidt8 , the documentation is now live for review at https://627d5be4c229560ba620c84d--docs-rapids-ai.netlify.app/api/cuspatial/nightly/ !

Comment thread docs/source/api_docs/internals.rst
@harrism
harrism requested a review from thomcom May 20, 2022 01:00
@harrism

harrism commented May 20, 2022

Copy link
Copy Markdown
Member

@thomcom could you please review this PR?

Comment on lines +74 to +87
"mlines":
[1, 3]
})

Which encodes a GeoPandas Series::

series = geopandas.Series([
LineString((0, 0), (0, 1), (0, 2)),
MultiLineString([(1, 0), (1, 1), (1, 2)],
[(2, 0), (2, 1), (2, 2)],
)
LineString((3, 0), (3, 1), (3, 2)),
LineString((4, 0), (4, 1), (4, 2)),
])

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.

Heya, sorry for not being in this convo earlier. I'll be looking into dropping the 'bounding regions' in the mlines object to fit GeoArrow format correctly.

@harrism

harrism commented May 30, 2022

Copy link
Copy Markdown
Member

@gpucibot merge

@rapids-bot
rapids-bot Bot merged commit 38d9e50 into rapidsai:branch-22.06 May 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

3 - Ready for Review Ready for review by team conda Related to conda and conda configuration improvement Improvement / enhancement to an existing function non-breaking Non-breaking change Python Related to Python code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Update cuSpatial documentation to use PyData Sphinx theme

5 participants