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] Cudf python API lookup has long latency #7098

Closed
isVoid opened this issue Jan 7, 2021 · 4 comments · Fixed by #8746
Closed

[DOC] Cudf python API lookup has long latency #7098

isVoid opened this issue Jan 7, 2021 · 4 comments · Fixed by #8746
Assignees
@galipremsagar
Labels
doc Documentation Python Affects Python cuDF API.
Projects
v21.10 Release

Comments

@isVoid
Copy link
Contributor

isVoid commented Jan 7, 2021 •
edited
Loading

Describe the problems or issues found in the documentation
Currently, when I need to lookup a API signature from the documentation, the documentation site would first serve the page that contains every function API of cudf, then jump to the right section that has the function signature. This introduces unnecessary latency for a single function lookup.

Suggested fix for documentation
A few different solutions may be implemented:

  1. Serve every function into its own page. Like how pandas does it.
  2. Create group/modules hierarchies, on the atomic level, serve module/class as a single page, jump to the API on that page. Like how libcudf/doxygen does it.

Other solutions also welcomed.
@isVoid isVoid added doc Documentation Needs Triage Need team to review and classify labels Jan 7, 2021
@github-actions github-actions bot added this to Needs prioritizing in Other Issues Jan 7, 2021
@galipremsagar
Copy link
Contributor

galipremsagar commented Jan 7, 2021 •
edited
Loading

So the root cause of this problem is that our entire documentation is written into a single html file(api.html) by sphinx and because of this it takes time for any browser to load and scroll to a specific section in the html file - we should probably find a way to chunk these out into separate html files

@kkraus14 kkraus14 added Python Affects Python cuDF API. and removed Needs Triage Need team to review and classify labels Jan 8, 2021
@github-actions
Copy link

This issue has been marked stale due to no recent activity in the past 30d. 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 marked rotten if there is no activity in the next 60d.

@github-actions github-actions bot added the stale label Feb 16, 2021
@galipremsagar galipremsagar self-assigned this Mar 11, 2021
@galipremsagar galipremsagar added this to Issue-Needs prioritizing in v0.19 Release via automation Mar 11, 2021
@github-actions
Copy link

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.

@isVoid
Copy link
Contributor Author

isVoid commented Apr 11, 2021

This is being worked on by @galipremsagar in v0.20.

@galipremsagar galipremsagar removed this from Issue-Needs prioritizing in v0.19 Release Apr 11, 2021
@galipremsagar galipremsagar added this to Issue-Needs prioritizing in v21.06 Release via automation Apr 11, 2021
@kkraus14 kkraus14 removed this from Needs prioritizing in Other Issues May 24, 2021
@kkraus14 kkraus14 added this to Issue-Needs prioritizing in v21.08 Release via automation May 24, 2021
@kkraus14 kkraus14 removed this from Issue-Needs prioritizing in v21.06 Release May 24, 2021
@kkraus14 kkraus14 moved this from Issue-Needs prioritizing to Issue-P2 in v21.08 Release May 24, 2021
@beckernick beckernick removed this from Issue-P2 in v21.08 Release Jul 14, 2021
@beckernick beckernick added this to Issue-Needs prioritizing in v21.10 Release via automation Jul 14, 2021
@beckernick beckernick moved this from Issue-Needs prioritizing to Issue-P0 in v21.10 Release Jul 14, 2021
@galipremsagar galipremsagar mentioned this issue Jul 15, 2021
Merged
10 tasks
v21.10 Release automation moved this from Issue-P0 to Done Aug 10, 2021
rapids-bot bot pushed a commit that referenced this issue Aug 10, 2021
@galipremsagar
Change cudf docs theme to pydata theme (#8746)
4b9a35e 
Fixes: #7098

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

- [x] 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**.
- [x] Replaced `sphinx_rtd_theme` usages with `pydata-sphinx-theme`.
- [x] Removed `copybutton` being used in code samples, `pydata-sphinx-theme` has this support inbuilt.
- [x] Introduced rapids color scheme 🟪  css styling into `pydata-sphinx-theme`.
- [x] Removed some dead-code related to `markdown` in docs. - We no longer use markdown in docs.
- [x] 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.
- [x] Removed the rapids css which is now not needed: `"https://docs.rapids.ai/assets/css/custom.css"`
- [x] Fixed reference errors in multipe places in docstrings; for ex: replaced `cudf.core.series.Series.factorize` with `cudf.Series.factorize`.
- [x] Make top-level import of `StringIndex` possible, previously we cannot do `cudf.StringIndex`, this PR enables it.
- [x] 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/

Authors:
  - GALI PREM SAGAR (https://github.com/galipremsagar)

Approvers:
  - Keith Kraus (https://github.com/kkraus14)
  - Michael Wang (https://github.com/isVoid)
  - Vukasin Milovanovic (https://github.com/vuule)
  - Benjamin Zaitlen (https://github.com/quasiben)
  - AJ Schmidt (https://github.com/ajschmidt8)

URL: #8746
This was referenced Oct 29, 2021
Open
Closed
This was referenced Oct 29, 2021
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@galipremsagar galipremsagar

Labels
doc Documentation Python Affects Python cuDF API.
Projects
No open projects
v21.10 Release
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[REVIEW] Change cudf docs theme to pydata theme galipremsagar/cudf
3 participants
@kkraus14 @galipremsagar @isVoid