tgm/mkdocs.yml at main · tgm-team/tgm · 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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
---
site_name: TGM Docs
site_url: https://tgm.readthedocs.io/en/latest/
repo_url: https://github.com/tgm-team/tgm

nav:
  - Home:
      - index.md
      - Quickstart: quickstart.md
      - Architecture: architecture.md

  - Tutorials:
      - Temporal Graph Construction: tutorials/dgraph_tutorial.md
      - Time Management: tutorials/time_delta_tutorial.md
      - Hooks: tutorials/hook_tutorial.md

  - API Reference:
      - Dynamic Graphs:
          - DGraph: api/graph.md
          - DGBatch: api/batch.md
          - TimeDelta: api/timedelta.md
      - Datasets: api/data.md
      - Data Loading: api/loader.md
      - Hooks:
          - Hooks: api/hooks/hooks.md
          - Hook Manager: api/hooks/hook_manager.md
          - Recipes: api/hooks/recipe.md
      - Neural Layers: api/nn.md
      - Utilities: api/util.md
      - Constants: api/constants.md

validation:
  links:
    anchors: warn

theme:
  name: material
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.path
    - search.highlight
    - search.suggest
    - toc.follow
    - toc.integrate
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      accent: lime
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
          paths: [tgm]
          options:
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: list
            filters: ["!^_"]
            heading_level: 3
            inherited_members: false
            merge_init_into_class: true
            separate_signature: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_source: true
            signature_crossrefs: true
            summary: true