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

removed autosummary from linen docs #3792

Merged
merged 1 commit into from
Apr 9, 2024

Conversation

chiamp
Copy link
Collaborator

@chiamp chiamp commented Mar 27, 2024

On the Linen API table of contents, there are duplicate entries because of autosummary:
Screenshot 2024-04-08 at 6 12 24 PM

This PR removes autosummary from the Linen API reference so that the table of contents won't contain duplicate entries. As a consequence, this will remove the summary table at the end of the page for every API reference, for example in Init/Apply:
image

@chiamp chiamp self-assigned this Mar 27, 2024
@chiamp chiamp marked this pull request as draft March 27, 2024 20:24
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.62%. Comparing base (6f1f1ef) to head (219c704).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3792   +/-   ##
=======================================
  Coverage   59.62%   59.62%           
=======================================
  Files         101      101           
  Lines       12655    12655           
=======================================
  Hits         7546     7546           
  Misses       5109     5109           

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

@chiamp chiamp force-pushed the autosummary branch 3 times, most recently from 0641892 to 5b539e0 Compare April 9, 2024 01:05
@chiamp chiamp changed the title fixed autosummary removed autosummary from linen docs Apr 9, 2024
@chiamp chiamp marked this pull request as ready for review April 9, 2024 01:28
@chiamp chiamp requested a review from cgarciae April 9, 2024 01:28
@copybara-service copybara-service bot merged commit 5ce3485 into google:main Apr 9, 2024
19 checks passed
@chiamp chiamp deleted the autosummary branch April 9, 2024 18:32
@chiamp chiamp mentioned this pull request Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants