mkdocs.yml

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: Sylva Identity Discovery
site_url: https://sylva.pfeister.dev
site_author: Paul Pfeister
site_description: Novel identity discovery utility

repo_name: ppfeister/sylva
repo_url: https://github.com/ppfeister/sylva

copyright: >
  Copyright &copy; 2024 <a href="https://pfeister.dev/" target="_blank">Paul Pfeister</a> &nbsp;–&nbsp;
  <a href="#__consent">Change cookie settings</a>

theme:
  name: material
  favicon: assets/favicon.png
  logo: assets/logo.png
  features:
    - navigation.tracking
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - content.code.annotate
    - content.code.copy
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: light blue
      accent: light blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: light blue
      accent: light blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode



plugins:
  - mkdocstrings:
      default_handler: python
      enable_inventory: true
      handlers:
        python:
          import:
            - https://pandas.pydata.org/pandas-docs/stable/objects.inv
          selection:
            filters:
              - "!^_"  # exclude all members starting with _
          options:
            show_root_heading: true
            show_source: false
            heading_level: 4
            merge_init_into_class: true
            show_root_full_path: true
            show_root_toc_entry: false
            show_if_no_docstring: false
            show_signature_annotations: false
            separate_signature: true
  - minify:
      minify_html: true
  - privacy
  - git-revision-date
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ppfeister
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/sylva/sylva
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/sylva
    - icon: fontawesome/solid/heart
      link: https://github.com/sponsors/ppfeister
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
      <br><br>
      Ultimately, this isn't a commercial project, and we'd like to know where
      to direct our limited resources.
  analytics:
    provider: google
    property: G-8HJW3DB3RW
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/heart
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/heart-broken
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            opening a discussion on our <a href="https://github.com/ppfeister/sylva/issues/new/?title=[MkDocs]+{title}+-+{url}" target="_blank" rel="noopener">repository</a>.

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

nav:
  - Home: index.md
  - Getting Started:
    - Install Sylva (simple): install.md
    - Install Sylva (advanced): install-adv.md
  - API Reference:
    - Programmatic Examples: reference/examples.md
    - sylva.Collector: reference/sylva.Collector.md
    - sylva.console: reference/sylva.console.md
    - sylva.handler: reference/sylva.handler.md
    - sylva.types: reference/sylva.types.md
    - sylva.errors: reference/sylva.errors.md
  - Contributing:
    - Introduction: contributing/introduction.md
    - Documentation: contributing/documentation.md
    - Regression Testing: contributing/regression.md
  - Sponsor: https://github.com/sponsors/ppfeister