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

Improve Sphinx AutoAPI Readability #108

Merged
merged 3 commits into from
Jun 11, 2024
Merged

Improve Sphinx AutoAPI Readability #108

merged 3 commits into from
Jun 11, 2024

Conversation

dougbrn
Copy link
Collaborator

@dougbrn dougbrn commented Jun 10, 2024

This PR removes a lot of bloat in the current sphinx autoapi generation configuration. Submodules had repeated NestedFrame API entries because imported classes were documented by default. This was disabled, and private functions were also disabled from being rendered. Also, removed the lingering PPT example benchmark code which was being rendered.

Copy link

github-actions bot commented Jun 10, 2024

Before [5cf1fa5] After [544553c] Ratio Benchmark (Parameter)
34.8±3ms 34.6±2ms 1 benchmarks.AssignSingleDfToNestedSeries.time_run
84.3M 84M 1 benchmarks.NestedFrameAddNested.peakmem_run
8.88±0.1ms 8.88±0.05ms 1 benchmarks.NestedFrameAddNested.time_run
87.3M 87.2M 1 benchmarks.NestedFrameReduce.peakmem_run
6.16±0.05ms 6.06±0.02ms 0.98 benchmarks.NestedFrameQuery.time_run
264M 255M 0.97 benchmarks.AssignSingleDfToNestedSeries.peakmem_run
90.4M 87.5M 0.97 benchmarks.NestedFrameQuery.peakmem_run
1.07±0.01ms 1.03±0.01ms 0.97 benchmarks.NestedFrameReduce.time_run
280M 273M 0.97 benchmarks.ReassignHalfOfNestedSeries.peakmem_run
60.6±2ms 54.9±0.8ms 0.91 benchmarks.ReassignHalfOfNestedSeries.time_run

Click here to view all benchmarks.

Copy link

codecov bot commented Jun 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.43%. Comparing base (5cf1fa5) to head (1f958fb).
Report is 46 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #108      +/-   ##
==========================================
+ Coverage   98.76%   99.43%   +0.66%     
==========================================
  Files          15       14       -1     
  Lines         894      888       -6     
==========================================
  Hits          883      883              
+ Misses         11        5       -6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dougbrn dougbrn changed the title avoid NestedFrame API in generation module Improve Sphinx AutoAPI Readability Jun 10, 2024
@dougbrn dougbrn marked this pull request as ready for review June 10, 2024 22:41
@dougbrn dougbrn requested a review from hombit June 10, 2024 22:49
Copy link
Collaborator

@hombit hombit left a comment

Choose a reason for hiding this comment

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

Very nice!

@dougbrn dougbrn merged commit c44bfe1 into main Jun 11, 2024
11 checks passed
@dougbrn dougbrn deleted the fix_autoapi_hits branch June 11, 2024 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants