_quarto.yml

project:
  type: website

website:
  title: "**pprl**"
  navbar:
    left:
      - href: index.qmd
        text: About
      - href: docs/tutorials/index.qmd
        text: Tutorials
      - href: docs/reference/index.qmd
        text: API Reference
    right:
      - icon: github
        menu:
          - text: Source code
            url: https://github.com/datasciencecampus/pprl_toolkit
          - text: Open an issue
            url: https://github.com/datasciencecampus/pprl_toolkit/issues
  sidebar:
    style: docked
    search: true
    contents:
      - text: About
        href: index.qmd
      - auto: "*.qmd"
  reader-mode: true
  page-footer:
    left: >
      All content is available under the
      [Open Government Licence V3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/),
      except where otherwise stated.
    center: >
      Built using [Quarto](https://quarto.org/).

format:
  html:
    mainfont: Arial
    theme:
      light: flatly
      dark: darkly
    lang: en-GB

metadata-files:
  - docs/_sidebar.yml

quartodoc:
  title: API reference
  package: pprl
  dir: docs/reference
  sidebar: docs/_sidebar.yml
  sections:
    - title: Embeddings
      desc: >
        Tools for generating a Bloom filter embedding and its underlying
        features.
      package: pprl.embedder
      contents:
        - bloom_filters
        - embedder
        - features
    - title: Encryption
      desc: Functions for handling the data and key encryption processes.
      contents:
        - encryption
    - title: Configuration
      desc: Functions for working out and handling linkage configuration.
      contents:
        - config
    - title: Client-side app
      desc: >
        Functions for the Flask application where users upload, process, and
        download their data.
      package: pprl.app
      contents:
        - utils
    - title: Server functions
      desc: >
        Functions for the matching workload server. Used in `scripts/server.py`
      package: pprl.matching
      contents:
        - cloud
        - local
        - perform