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.

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

Fix docs for IO readers and strings_convert #15842

Merged
merged 3 commits into from
May 24, 2024

Conversation

bdice
Copy link
Contributor

@bdice bdice commented May 23, 2024

Description

Fixes documentation for IO readers and strings_convert.

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@bdice bdice changed the base branch from branch-24.06 to branch-24.08 May 23, 2024 20:27
@github-actions github-actions bot added libcudf Affects libcudf (C++/CUDA) code. Python Affects Python cuDF API. CMake CMake build issue conda Java Affects Java cuDF API. labels May 23, 2024
@bdice bdice added doc Documentation non-breaking Non-breaking change and removed libcudf Affects libcudf (C++/CUDA) code. Python Affects Python cuDF API. CMake CMake build issue conda Java Affects Java cuDF API. labels May 23, 2024
@bdice bdice self-assigned this May 23, 2024
@bdice bdice changed the base branch from branch-24.08 to branch-24.06 May 23, 2024 21:03
@bdice bdice changed the title Fix docs for IO readers Fix docs for IO readers and strings_convert May 23, 2024
@bdice bdice marked this pull request as ready for review May 24, 2024 01:47
@vyasr
Copy link
Contributor

vyasr commented May 24, 2024

/merge

@rapids-bot rapids-bot bot merged commit 8a40567 into rapidsai:branch-24.06 May 24, 2024
74 checks passed
vyasr added a commit that referenced this pull request May 28, 2024
raydouglass pushed a commit that referenced this pull request May 29, 2024
Reverts #15842

The files the original PR added documentation for appear to contain some
text that is problematic for the Sphinx parser to extract from doxygen.
My best guess is that it's something in a table, since parsing doxygen
tables via Breathe is something I know can be tricky. We didn't catch
this issue because [we currently only build the text docs in nightly
builds, not
PRs](https://github.com/rapidsai/cudf/blob/branch-24.08/ci/build_docs.sh#L49),
and this issue only arises in those text builds. We can revisit adding
these docs in 24.08. For the sake of correctness, I have added back
building text docs in PRs in this PR (see #14856 for context on the
removal).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants