mkdocs.yml

site_name: requests-htmlc
site_description: Fork of Requests-HTML, using PlayWright
strict: true
site_url: https://cboin1996.github.io/requests-html
site_dir: public

repo_name: cboin1996/requests-html
repo_url: https://github.com/cboin1996/requests-html
edit_uri: ""

theme:
  name: material
  features:
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - announce.dismiss
    - navigation.tabs
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.preview
    - navigation.instant.progress
    - navigation.path
    - navigation.top
    - navigation.tracking
    - search.suggest
    - toc.follow
  palette:
    # Palette toggle for dark mode
    - scheme: slate
      primary: blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Palette toggle for light mode
    - scheme: default
      primary: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

# https://www.mkdocs.org/user-guide/configuration/#validation
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

nav:
- Get Started:
  - Welcome to Requests-HTMLC: index.md
- API Documentation:
  - requests-htmlc:
    - requests_html: requests-htmlc/requests_html.md

extra:
  version:
    provider: mike

plugins:
- search
- mkdocstrings:
    enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
    default_handler: python
    handlers:
      python:
        options:
          docstring_style: google
          show_root_heading: true
          show_root_full_path: true
          show_root_toc_entry: true
          docstring_section_style: list
          show_source: true
          show_bases: true
          merge_init_into_class: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true