Skip to content

Simplify Python doc configuration - #13826

Merged
rapids-bot[bot] merged 10 commits into
NVIDIA:branch-23.10from
vyasr:feat/simplify_doc_conf
Aug 8, 2023
Merged

Simplify Python doc configuration#13826
rapids-bot[bot] merged 10 commits into
NVIDIA:branch-23.10from
vyasr:feat/simplify_doc_conf

Conversation

@vyasr

@vyasr vyasr commented Aug 7, 2023

Copy link
Copy Markdown
Contributor

Description

This PR is a follow-up to #13789 that adds specified lists of methods/attributes to some classes; removes redundancy in the autosummary templates we are using and adds documentation explaining how they work; and removes various pieces of outdated code in our conf.py to make it easier to maintain going forward.

Checklist

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

@vyasr vyasr added 3 - Ready for Review Ready for review by team doc Documentation non-breaking Non-breaking change labels Aug 7, 2023
@vyasr
vyasr requested a review from a team as a code owner August 7, 2023 17:12
@vyasr vyasr self-assigned this Aug 7, 2023
@vyasr
vyasr requested review from bdice and mroeschke August 7, 2023 17:12
@github-actions github-actions Bot added the Python Affects Python cuDF API. label Aug 7, 2023

@mroeschke mroeschke left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hope pandas can remove class_without_autosummary.rst one day :)

@vyasr

vyasr commented Aug 8, 2023

Copy link
Copy Markdown
Contributor Author

Let's hope pandas-dev/pandas#54457 :)

@vyasr

vyasr commented Aug 8, 2023

Copy link
Copy Markdown
Contributor Author

/merge

@rapids-bot
rapids-bot Bot merged commit 9b80bfd into NVIDIA:branch-23.10 Aug 8, 2023
@vyasr
vyasr deleted the feat/simplify_doc_conf branch August 8, 2023 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3 - Ready for Review Ready for review by team doc Documentation non-breaking Non-breaking change Python Affects Python cuDF API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants