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

Support type-dependent search result highlighting via CSS #12474

Merged
merged 8 commits into from
Aug 11, 2024

Commits on Jul 25, 2024

  1. ENH: Add type-dependent class to search result entries

    This allows styling different types of results individually.
    It's helpful to visually distinguish different content types.
    
    This PR adds `context` to the javascript result entries
    (one of "title", "index", "object", "text") and adds
    them as a classes context-title, context-index, context-object,
    context-text to the <li> item in the result list.
    This allows styling via CSS.
    
    The basic theme only contains the mechanism to add the HTML
    classes. It does intentionally not do any styling via CSS.
    We reserve that freedom to derived themes.
    
    For the internal sphinx13 theme, I've styled with unicode
    symbols, which should give a decent look without the need
    to ship our own symbols.
    
    Co-authored-by: Adam Turner <[email protected]>
    timhoffm and AA-Turner committed Jul 25, 2024
    Configuration menu
    Copy the full SHA
    4c7952a View commit details
    Browse the repository at this point in the history
  2. Apply suggestions from code review

    Co-authored-by: James Addison <[email protected]>
    timhoffm and jayaddison authored Jul 25, 2024
    Configuration menu
    Copy the full SHA
    684cdad View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    3a2a337 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    7dbbbdc View commit details
    Browse the repository at this point in the history

Commits on Jul 27, 2024

  1. Configuration menu
    Copy the full SHA
    bbccc5e View commit details
    Browse the repository at this point in the history

Commits on Aug 11, 2024

  1. Merge branch 'master' into search-icons

    # Conflicts:
    #	CHANGES.rst
    AA-Turner committed Aug 11, 2024
    Configuration menu
    Copy the full SHA
    eb8db20 View commit details
    Browse the repository at this point in the history
  2. refwarning

    AA-Turner committed Aug 11, 2024
    Configuration menu
    Copy the full SHA
    d3c24c1 View commit details
    Browse the repository at this point in the history
  3. test

    AA-Turner committed Aug 11, 2024
    Configuration menu
    Copy the full SHA
    531efce View commit details
    Browse the repository at this point in the history