mkdocs.yml

site_name: spacypdfreader
site_description: PDF to spaCy text extraction.
repo_url: https://github.com/samedwardes/spacypdfreader
repo_name: 'samedwardes/spacypdfreader'
edit_uri: ''

theme:
  name: material
  icon:
    logo: fontawesome/solid/user-astronaut
  favicon: assets/images/user-astronaut-solid.svg
  features:
    - search.suggest
    - search.highlight
    - content.code.annotate
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: true

plugins:
  - search
  - include-markdown
  - mkdocstrings:
      watch:
        - spacypdfreader
      handlers:
        python:
          selection:
            filters:
              - "!^_"  # exlude all members starting with _
              - "^__init__$"  # but always include __init__ modules and methods
          rendering:
            show_category_heading: false
            show_root_heading: true
            show_signature_annotations: true

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/samedwardes/spacypdfreader
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/therealsamlam
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/samedwardes

nav:
  - Home: 'index.md'
  - parsers.md
  - multiprocessing.md
  - changelog.md
  - contributing.md
  - API reference:
    - api/spacy-extensions.md
    - api/spacypdfreader.spacypdfreader.md
    - api/spacypdfreader.parsers.md