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

[FEA] Make pylibcudf docs more visible #17190

Open
vyasr opened this issue Oct 28, 2024 · 1 comment · May be fixed by #17803
Open

[FEA] Make pylibcudf docs more visible #17190

vyasr opened this issue Oct 28, 2024 · 1 comment · May be fixed by #17803
Assignees
@Matt711
Labels
doc Documentation feature request New feature or request pylibcudf Issues specific to the pylibcudf package Python Affects Python cuDF API.

Comments

@vyasr
Copy link
Contributor

vyasr commented Oct 28, 2024

Is your feature request related to a problem? Please describe.
pylibcudf was initially developed from within cudf Python as a subpackage. As a result, both its API documentation and its developer guide are somewhat hidden from view.

Describe the solution you'd like
We should elevate pylibcudf to the top bar of the Sphinx docs and move both its API and developer documentation into a more discoverable location. When we do so, we should also update cudf's library design developer docs to indicate that the Cython layer is now deprecated and being migrated to pylibcudf. We should also add a note indicating that the Column layer is likely to change in the near future as a result of rewriting around pylibcudf.
@vyasr vyasr added the feature request New feature or request label Oct 28, 2024
@vyasr vyasr added doc Documentation Python Affects Python cuDF API. pylibcudf Issues specific to the pylibcudf package labels Oct 28, 2024
@Matt711 Matt711 mentioned this issue Nov 26, 2024
Closed
3 tasks
@bdice
Copy link
Contributor

bdice commented Nov 26, 2024

Before we elevate pylibcudf, we should do a pass through the docs and fix all the typos that are causing things to render improperly, like this one where the C++ reference is not parsed:
Image

@Matt711 Matt711 assigned Matt711 and unassigned bdice Jan 23, 2025
@Matt711 Matt711 linked a pull request Jan 24, 2025 that will close this issue
Open
3 tasks
@Matt711 Matt711 moved this from Todo to In Progress in cuDF Python Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Matt711 Matt711

Labels
doc Documentation feature request New feature or request pylibcudf Issues specific to the pylibcudf package Python Affects Python cuDF API.
Projects
cuDF Python
Status: In Progress
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[DOC] Make pylibcudf docs more visible Matt711/cudf
3 participants
@vyasr @bdice @Matt711