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

Use fullname for autosummary #4368

Merged
merged 1 commit into from
May 2, 2023
Merged

Use fullname for autosummary #4368

merged 1 commit into from
May 2, 2023

Conversation

akaszynski
Copy link
Member

Eliminate duplicate pages within our documentation search by using the fullname of a class method in the autosummary. For example:

https://docs.pyvista.org/version/dev/search.html?q=clean

main branch

a

This branch

b

(note that displaying the text requires the documentation to be hosted)

@github-actions github-actions bot added the documentation Anything related to the documentation/website label May 1, 2023
@akaszynski akaszynski mentioned this pull request May 1, 2023
6 tasks
@codecov
Copy link

codecov bot commented May 1, 2023

Codecov Report

Merging #4368 (45a224f) into main (caa1129) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #4368   +/-   ##
=======================================
  Coverage   95.81%   95.81%           
=======================================
  Files          97       97           
  Lines       20814    20814           
=======================================
  Hits        19942    19942           
  Misses        872      872           

Copy link
Member

@tkoyama010 tkoyama010 left a comment

Choose a reason for hiding this comment

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

Good! Makes it more visible.

@akaszynski akaszynski merged commit 4c2d1ae into main May 2, 2023
25 checks passed
@akaszynski akaszynski deleted the docs/fix-auto-summary-name branch May 2, 2023 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to the documentation/website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants