mkdocs.yml

site_name: CAVEclient
site_url: https://caveconnectome.github.io/CAVEclient/
repo_url: https://github.com/CAVEconnectome/CAVEclient/
repo_name: CAVEconnectome/CAVEclient
edit_uri: edit/master/docs/
nav:
  - Home: index.md
  - Installation: installation.md
  - Tutorial:
    - tutorials/index.md
    - tutorials/framework.md
    - tutorials/authentication.md
    - tutorials/annotation.md
    - tutorials/chunkedgraph.md
    - tutorials/l2cache.md
    - tutorials/info.md
    - tutorials/schemas.md
    - tutorials/state.md
    - tutorials/materialization.md
    - tutorials/skeletonization.md
    - tutorials/advanced.md
  - API reference: # these match the client property names
    # - api/index.md
    - Client API:
      - api/client.md
      - api/annotation.md
      - api/auth.md
      - api/chunkedgraph.md
      - api/info.md
      - api/l2cache.md
      - api/materialize.md
      - api/schema.md
      - api/skeleton.md
      - api/state.md
    - General functions: 
      - api/config.md
      - api/datastack_lookup.md
      - api/testing.md
  - Glossary: glossary.md
  - Contributing: contributing.md
  - Changelog: changelog.md
theme:
  name: material
  language: en
  logo: images/logo-cleanest.png
  favicon: images/logo-cleanest.png
  palette:
    scheme: preference
    primary: black
    accent: indigo
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.indexes
    - navigation.instant
    - navigation.footer
    # - navigation.path
    - navigation.prune
    # - navigation.sections # toggle to have sections in side nav
    - navigation.tabs # toggle to mainly use top nav
    - navigation.tabs.sticky
    - content.action.edit
    - content.action.view
    - toc.integrate # whether to include the toc in the main nav bar to the left
    - toc.follow
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
markdown_extensions:
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.tabbed
  - attr_list
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      linenums: false
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.details
  - admonition
  - toc:
      baselevel: 2
      permalink: true
  - meta
plugins:
  - include-markdown
  - search:
      lang: en
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://pandas.pydata.org/pandas-docs/stable/objects.inv
            - https://networkx.org/documentation/stable/objects.inv
            - https://docs.scipy.org/doc/scipy/objects.inv
            - https://requests.readthedocs.io/en/latest/objects.inv
            - https://urllib3.readthedocs.io/en/stable/objects.inv
          options:
            show_source: false
            docstring_style: numpy
            docstring_section_style: table # list, table, spacy
            docstring_options:
              ignore_init_summary: false
            merge_init_into_class: false
            allow_section_blank_line: false
            show_root_heading: false
            show_root_toc_entry: false
            show_object_full_path: false
            show_symbol_type_heading: false # whether to show "meth/func/etc" in the page
            show_symbol_type_toc: false # whether to show "meth/func/etc" in the toc
            signature_crossrefs: true # https://mkdocstrings.github.io/python/usage/configuration/signatures/#signature_crossrefs
            members_order: alphabetical # can be source
            group_by_category: true  # order is attributes, classes, functions, modules
            summary: true
            show_if_no_docstring: false
            show_docstring_attributes: false
            annotations_path: brief # https://mkdocstrings.github.io/python/usage/configuration/signatures/#annotations_path
            show_signature: true
            separate_signature: false
            show_signature_annotations: false
            unwrap_annotated: false # https://mkdocstrings.github.io/python/usage/configuration/signatures/#unwrap_annotated
            heading_level: 2
            inherited_members: true
            # members: none
            filters: ["!^_[^_]", "!.*(raise_for_status).*", "!__init__"]
  - macros
  - autorefs
  # - section-index
  # - git-authors: # this one is more email-based
  #     show_contribution: true
  #     authorship_threshold_percent: 5
  # - git-committers: 
      # repository: seung-lab/CAVEclient
      # branch: main
  # - git-revision-date-localized:
  #     enable_creation_date: true
  # - social:
  #     cards_layout: default

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/CAVEconnectome/CAVEclient
      name: Github
  # version:
  #   provider: mike
  names: 
    repo_title: CAVEclient
    package: caveclient
    main_branch: master
  api_paths:
    annotation: ../api/annotation.md#caveclient.annotationengine.AnnotationClient
    auth: ../api/auth.md#caveclient.auth.AuthClient
    chunkedgraph: ../api/chunkedgraph.md#caveclient.chunkedgraph.ChunkedGraphClient
    materialize: ../api/materialize.md#caveclient.materializationengine.MaterializationClient
    l2cache: ../api/l2cache.md#caveclient.l2cache.L2CacheClient
    state: ../api/state.md#caveclient.jsonservice.JSONService
    schema: ../api/schema.md#caveclient.emannotationschemas.SchemaClient
    skeleton: ../api/client.md#caveclient.skeletonservice.SkeletonClient
  tutorial_paths:
    skeleton: ../tutorials/skeletonization.md

watch:
  - caveclient/
  - docs/
  # to enable disqus, uncomment the following and put your disqus id below
  # disqus: disqus_id
# uncomment the following and put your google tracking id below to enable GA
#google_analytics:
  #- UA-xxx
  #- auto