Skip to content

[REVIEW] Change cudf docs theme to pydata theme - #8746

Merged
rapids-bot[bot] merged 87 commits into
NVIDIA:branch-21.10from
galipremsagar:chunked_docs
Aug 10, 2021
Merged

[REVIEW] Change cudf docs theme to pydata theme#8746
rapids-bot[bot] merged 87 commits into
NVIDIA:branch-21.10from
galipremsagar:chunked_docs

Conversation

@galipremsagar

@galipremsagar galipremsagar commented Jul 15, 2021

Copy link
Copy Markdown
Contributor

Fixes: #7098

This PR changes our docs theme to pydata theme: https://github.com/pydata/pydata-sphinx-theme, rest of the additional changes include:

  • Revamps cudf docs theme to use pydata theme, and made changes to generate separate html pages for each API thus docs are not going to take ~30s to load anymore, you should see the doc page for each API load almost instantly.
  • Replaced sphinx_rtd_theme usages with pydata-sphinx-theme.
  • Removed copybutton being used in code samples, pydata-sphinx-theme has this support inbuilt.
  • Introduced rapids color scheme 🟪 css styling into pydata-sphinx-theme.
  • Removed some dead-code related to markdown in docs. - We no longer use markdown in docs.
  • Moved all Class-related docstrings into Class declarations rather than in their __init__ methods, to make the docstrings be uniform for autoclass_content to work correctly.
  • Removed the rapids css which is now not needed: "https://docs.rapids.ai/assets/css/custom.css"
  • Fixed reference errors in multipe places in docstrings; for ex: replaced cudf.core.series.Series.factorize with cudf.Series.factorize.
  • Make top-level import of StringIndex possible, previously we cannot do cudf.StringIndex, this PR enables it.
  • Enable top-level imports for pivot & unstack: cudf.pivot & cudf.unstack.

For reviewing purposes, a demo live url to docs is here: https://6111734dedccb71ae0db66dc--docs-rapids-ai.netlify.app/api/cudf/stable/

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions github-actions Bot added conda Python Affects Python cuDF API. labels Jul 15, 2021
@codecov

codecov Bot commented Jul 15, 2021

Copy link
Copy Markdown

Codecov Report

❗ No coverage uploaded for pull request base (branch-21.10@a4eabf0). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@               Coverage Diff               @@
##             branch-21.10    #8746   +/-   ##
===============================================
  Coverage                ?   10.60%           
===============================================
  Files                   ?      116           
  Lines                   ?    19005           
  Branches                ?        0           
===============================================
  Hits                    ?     2015           
  Misses                  ?    16990           
  Partials                ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a4eabf0...2620c50. Read the comment docs.

@galipremsagar

galipremsagar commented Aug 9, 2021

Copy link
Copy Markdown
Contributor Author

@kkraus14 @isVoid resolved all the 3 concerns and here are the updated docs: https://6111734dedccb71ae0db66dc--docs-rapids-ai.netlify.app/api/cudf/stable/

@quasiben

Copy link
Copy Markdown
Contributor

Thanks @galipremsagar ! And thank you @kkraus14 and @isVoid for the reviews.

With the new theme and multiple pages we may want to consider restructuring a bit more. For example, the Basics heading no longer makes much sense and more interesting topics, like GDS, are not easily visible. Again, for another PR/discussion.

@quasiben

Copy link
Copy Markdown
Contributor

@gpucibot merge

@charlesbluca

Copy link
Copy Markdown
Contributor

Think this is still blocked by rapidsai/integration#336 and an ops approval

@ajschmidt8

Copy link
Copy Markdown
Member

just waiting for the changes in rapidsai/integration#336 to be published and then this can be approved and merged.

@galipremsagar galipremsagar added 5 - Ready to Merge Testing and reviews complete, ready to merge and removed 3 - Ready for Review Ready for review by team labels Aug 10, 2021
@ajschmidt8

Copy link
Copy Markdown
Member

GitHub is having issues which is probably why this didn't merge. Let's try another merge comment. If not, we'll wait a bit until their problems are resolved.

https://www.githubstatus.com/incidents/rmfrw9dfbtbp

@ajschmidt8

Copy link
Copy Markdown
Member

@gpucibot merge

@rapids-bot
rapids-bot Bot merged commit 4b9a35e into NVIDIA:branch-21.10 Aug 10, 2021
@ajschmidt8

Copy link
Copy Markdown
Member

had some doc build issues. this should fix it. i tested it locally: rapidsai/integration#338

@ajschmidt8

Copy link
Copy Markdown
Member

new docs are live: https://docs.rapids.ai/api/cudf/nightly/

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

Labels

5 - Ready to Merge Testing and reviews complete, ready to merge breaking Breaking change doc Documentation Python Affects Python cuDF API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Cudf python API lookup has long latency

7 participants