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 cuCIM documentation to use PyData Sphinx theme #133

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

[DOC] Update cuCIM documentation to use PyData Sphinx theme #133

beckernick opened this issue Oct 29, 2021 · 2 comments · Fixed by #138
Assignees
@quasiben @gigony
Labels
doc Improvements or additions to documentation
Milestone
v21.12.00

Comments

@beckernick
Copy link
Member

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 cuCIM documentation to the PyData Sphinx theme should improve the user experience for our documentation.
@beckernick beckernick added the doc Improvements or additions to documentation label Oct 29, 2021
@gigony gigony self-assigned this Oct 29, 2021
@gigony gigony added this to the v21.12.00 milestone Oct 29, 2021
@quasiben quasiben mentioned this issue Nov 2, 2021
Merged
@rapids-bot rapids-bot bot closed this as completed in #138 Nov 3, 2021
rapids-bot bot pushed a commit that referenced this issue Nov 3, 2021
@quasiben
update docs theme to pydata-sphinx-theme (#138)
10582fc 
Fixes #133

Authors:
  - Benjamin Zaitlen (https://github.com/quasiben)

Approvers:
  - https://github.com/jakirkham

URL: #138
@quasiben
Copy link
Member

quasiben commented Nov 4, 2021

The new theme is up for nightly docs:
Screen Shot 2021-11-04 at 9 24 26 AM

@galipremsagar
Copy link
Contributor

galipremsagar commented Nov 4, 2021 •
edited
Loading

I guess this is the correct cuCIM one:
Screen Shot 2021-11-04 at 8 26 20 AM

Seems like an alignment issue at top bar(cuCIM API reference button). Will fix it up later today.

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

@quasiben quasiben

@gigony gigony

Labels
doc Improvements or additions to documentation
Projects
None yet
Milestone
v21.12.00
Development

Successfully merging a pull request may close this issue.

update docs theme to pydata-sphinx-theme quasiben/cucim
4 participants
@quasiben @gigony @beckernick @galipremsagar