Skip to content
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

[DOC] Update cuSpatial documentation to use PyData Sphinx theme #459

Closed
beckernick opened this issue Oct 29, 2021 · 2 comments · Fixed by #523
Closed

[DOC] Update cuSpatial documentation to use PyData Sphinx theme #459

beckernick opened this issue Oct 29, 2021 · 2 comments · Fixed by #523
Labels
doc Documentation Needs Triage Need team to review and classify

Comments

@beckernick
Copy link
Member

beckernick commented Oct 29, 2021 •
edited by vyasr
Loading

As summarized by @isVoid in rapidsai/cudf#7098 , Python API documentation for RAPIDS projects has historically used the Sphinx Read The Docs theme and served a single large HTML page. This has caused the docs to load slowly as API surfaces have grown and caused users to experience potentially significant latency/delays when searching for functions.

In rapidsai/cudf#8746 , @galipremsagar updated the cuDF documentation to the more responsive PyData Sphinx theme. In rapidsai/cugraph#1793, @BradReesWork made a similar change.

Updating the cuSpatial documentation to the PyData Sphinx theme should improve the user experience for our documentation.
@beckernick beckernick added Needs Triage Need team to review and classify doc Documentation labels Oct 29, 2021
@github-actions
Copy link

github-actions bot commented Dec 1, 2021

This issue has been labeled inactive-30d due to no recent activity in the past 30 days. Please close this issue if no further response or action is needed. Otherwise, please respond with a comment indicating any updates or changes to the original issue and/or confirm this issue still needs to be addressed. This issue will be labeled inactive-90d if there is no activity in the next 60 days.

@github-actions
Copy link

github-actions bot commented Mar 1, 2022

This issue has been labeled inactive-90d due to no recent activity in the past 90 days. Please close this issue if no further response or action is needed. Otherwise, please respond with a comment indicating any updates or changes to the original issue and/or confirm this issue still needs to be addressed.

@isVoid isVoid mentioned this issue May 11, 2022
Merged
3 tasks
@rapids-bot rapids-bot bot closed this as completed in #523 May 30, 2022
rapids-bot bot pushed a commit that referenced this issue May 30, 2022
@isVoid
Update Documentation with Pydata Sphinx Theme, and more (#523)
38d9e50 
This PR closes #459 . It updates the sphinx theme with `Pydata-sphinx-theme`.

Besides this PR also:

- [x] Fixed all existing warnings emitted during rendering the doc
- [x] 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.
- [x] Minor improvement to `from_geopandas` docstring.

Authors:
  - Michael Wang (https://github.com/isVoid)

Approvers:
  - AJ Schmidt (https://github.com/ajschmidt8)
  - Mark Harris (https://github.com/harrism)
  - H. Thomson Comer (https://github.com/thomcom)

URL: #523
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Documentation Needs Triage Need team to review and classify
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update Documentation with Pydata Sphinx Theme, and more isVoid/cuspatial
1 participant
@beckernick