polygraph-benchmark/mkdocs.yml at master · BorgwardtLab/polygraph-benchmark · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
site_name: polygraph-benchmark
repo_url: https://github.com/BorgwardtLab/polygraph-benchmark
theme:
  name: readthedocs  # Optional, but makes docs look better
  features:
    - navigation.expand  # Expands all sections by default
    - navigation.side.indexes

nav:
  - index.md
  - Installation: installation.md
  - Tutorials:
    - Basic Usage: tutorials/basic_usage.md
    - Metrics Overview: tutorials/metrics_overview.md
    - Custom Datasets: tutorials/custom_datasets.md
  - Base API Reference:
    - polygraph.metrics:
      - Interface: api_reference/metrics/interface.md
      - MMD: api_reference/metrics/mmd.md
      - PolyGraphDiscrepancy: api_reference/metrics/polygraphdiscrepancy.md
      - Frechet: api_reference/metrics/frechet.md
    - polygraph.datasets:
      - Dataset Base Classes: api_reference/datasets/dataset_base_classes.md
      - NetworkX View: api_reference/datasets/networkx_view.md
      - Graph Serialization: api_reference/datasets/graph_serialization.md
    - polygraph.utils:
      - Graph Descriptors: api_reference/utils/graph_descriptors.md
      - Graph Kernels: api_reference/utils/graph_kernels.md
  - Standardized Metrics:
    - StandardPGD: metrics/standard_pgd.md
    - MoleculePGD: metrics/molecule_pgd.md
    - Gaussian TV MMD: metrics/gaussian_tv_mmd.md
    - RBF MMD: metrics/rbf_mmd.md
    - VUN: metrics/vun.md
  - Datasets:
    - Small Synthetic Datasets: datasets/small_synthetic.md
    - Procedural Datasets: datasets/procedural.md
    - Real-World Datasets: datasets/real_world_topologies.md
  - Utils:
    - Graph Descriptors: utils/descriptors.md
    - Graph Kernels: utils/kernels.md
    - MMD Utilities: utils/mmd_utils.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            extensions:
              - scripts/griffe_extension.py:JinjaDocstringExtension
      paths: [polygraph]

markdown_extensions:
  - admonition
  - pymdownx.arithmatex:
      generic: true


extra_javascript:
  - javascript/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js