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

DocSearch #1754

Merged
merged 7 commits into from
Mar 31, 2021
Merged

DocSearch #1754

merged 7 commits into from
Mar 31, 2021

Conversation

flying-sheep
Copy link
Member

@flying-sheep flying-sheep commented Mar 21, 2021

rendered

/edit: huh! weird, seems that readthedocs-sphinx-search pops up instead. why do we try to use docsearch instead of that one?

@codecov
Copy link

codecov bot commented Mar 21, 2021

Codecov Report

Merging #1754 (b35c972) into master (3fb1463) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1754   +/-   ##
=======================================
  Coverage   71.18%   71.18%           
=======================================
  Files          92       92           
  Lines       11190    11190           
=======================================
  Hits         7966     7966           
  Misses       3224     3224           

@ivirshup
Copy link
Member

I added the readthedocssphinx search when experimenting with which one to use. DocSearch just seemed a lot nicer. It's got fuzzy matching, so using UK vs US spelling doesn't matter, also gives more context about results.

pyproject.toml Outdated Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
Copy link
Member

@ivirshup ivirshup left a comment

Choose a reason for hiding this comment

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

Looks good now, must have been a cache issue. I'm good with merging, unless I'm forgetting something?

Release note would be good.

@ivirshup ivirshup merged commit d78511f into master Mar 31, 2021
@flying-sheep flying-sheep deleted the docsearch branch March 31, 2021 11:45
@flying-sheep
Copy link
Member Author

flying-sheep commented Mar 31, 2021

Looking good! But somehow there’s like 3 times the same for each result … I assume two are expected as one is the page title and one the doc item title (e.g. function name), and we have one page per function/class.

But shouldn’t one side of the vertical line be e.g. the first line of the docstring?

popup

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.

None yet

2 participants