test_searchlite¶

Attributes¶

`CONF`
`INDEX_MD`
`GUIDE_MD`

Classes¶

`TestIndex`
`TestAssets`
`TestUiDisabled`
`TestResultLinks`
`TestThemeSearchAdoption`
`TestCustomFilename`

Functions¶

`_build`(→ pathlib.Path)
`built`(→ pathlib.Path)
`records`(→ list[dict])

Module Contents¶

test_searchlite.CONF = Multiline-String¶

Show Value

"""
extensions = ["myst_parser", "sphinx_searchlite"]
project = "Demo"
html_theme = "basic"
"""

test_searchlite.INDEX_MD = Multiline-String¶

Show Value

"""
# Demo

Intro text.

```{toctree}

guide
```
"""

test_searchlite.GUIDE_MD = Multiline-String¶

Show Value

"""
# Guide

## First section

Content about widgets.

### Nested heading

More detail.

## Second section

Other content.
"""

test_searchlite._build(tmp_path_factory, conf: str, name: str) → pathlib.Path¶

test_searchlite.built(tmp_path_factory) → pathlib.Path¶

test_searchlite.records(built) → list[dict]¶

class test_searchlite.TestIndex¶

test_index_is_emitted(built)¶

test_page_records_carry_url_title_and_text(records)¶

test_sections_get_their_own_anchored_record(records)¶

test_section_text_excludes_nested_sections(records)¶

test_page_title_is_not_duplicated_as_a_section(records)¶

test_text_is_truncated_to_the_configured_limit(tmp_path_factory)¶

class test_searchlite.TestAssets¶

test_engine_is_linked_with_the_index_name(built)¶

test_bundled_ui_is_shipped_by_default(built)¶

class test_searchlite.TestUiDisabled¶

classmethod built(tmp_path_factory) → pathlib.Path¶

test_engine_is_still_shipped(built)¶

test_dialog_and_styles_are_omitted(built)¶

test_ui_assets_are_not_copied(built)¶

test_index_is_still_emitted(built)¶

class test_searchlite.TestResultLinks¶

test_urls_resolve_against_the_documentation_root(built)¶

class test_searchlite.TestThemeSearchAdoption¶

test_adoption_is_advertised_to_the_ui_script(built)¶

test_adoption_can_be_switched_off(tmp_path_factory)¶

test_adopted_fields_do_not_reopen_the_dialog_on_focus(built)¶

test_escape_closes_the_dialog_on_the_first_press(built)¶

test_styles_no_longer_hardcode_a_dark_palette(built)¶

test_palette_derives_from_two_variables(built)¶

class test_searchlite.TestCustomFilename¶

test_index_name_is_configurable(tmp_path_factory)¶