groggy/mkdocs.yml at main · rollingstorms/groggy · 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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
site_name: Groggy Documentation
site_description: High-performance graph analytics library for Python with a Rust core
site_author: Groggy Contributors
site_url: https://rollingstorms.github.io/groggy/

repo_name: rollingstorms/groggy
repo_url: https://github.com/rollingstorms/groggy
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            heading_level: 2

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - About Groggy: about.md
      - Installation: install.md
      - Quickstart: quickstart.md
  - Concepts:
      - Overview: concepts/overview.md
      - Origins & Design: concepts/origins.md
      - Architecture: concepts/architecture.md
      - Connected Views: concepts/connected-views.md
      - Trait-Backed Delegation: concepts/trait-delegation.md
  - User Guide:
      - Graph Core: guide/graph-core.md
      - Subgraphs: guide/subgraphs.md
      - Accessors: guide/accessors.md
      - SubgraphArrays: guide/subgraph-arrays.md
      - Tables: guide/tables.md
      - Arrays: guide/arrays.md
      - Matrices: guide/matrices.md
      - Builder DSL: guide/builder.md
      - Algorithms: guide/algorithms.md
      - Neural Networks: guide/neural.md
      - Integration: guide/integration.md
      - Performance: guide/performance.md
  - Algorithms:
      - Overview: guide/algorithms.md
      - Centrality:
          - PageRank: guide/algorithms.md
          - Betweenness: guide/algorithms.md
          - Closeness: guide/algorithms.md
      - Community Detection:
          - Label Propagation: guide/algorithms.md
          - Louvain: guide/algorithms.md
          - Leiden: guide/algorithms.md
          - Connected Components: guide/algorithms.md
      - Pathfinding:
          - BFS: guide/algorithms.md
          - DFS: guide/algorithms.md
          - Dijkstra: guide/algorithms.md
          - A*: guide/algorithms.md
  - Builder DSL:
      - Getting Started: builder/index.md
      - Batch Executor: guide/builder.md
      - Tutorials:
          - Hello World: builder/tutorials/01_hello_world.md
          - PageRank: builder/tutorials/02_pagerank.md
          - LPA: builder/tutorials/03_lpa.md
          - Custom Metrics: builder/tutorials/04_custom_metrics.md
      - API Reference:
          - Core Ops: builder/api/core.md
          - Graph Ops: builder/api/graph.md
          - Attr Ops: builder/api/attr.md
          - Iteration: builder/api/iter.md
          - VarHandle: builder/api/varhandle.md
  - API Reference:
      - Graph Objects:
          - Graph: api/graph.md
          - Subgraph: api/subgraph.md
          - SubgraphArray: api/subgrapharray.md
      - Algorithms: api/algorithms.md
      - Builder: api/builder.md
      - Accessors:
          - NodesAccessor: api/nodesaccessor.md
          - EdgesAccessor: api/edgesaccessor.md
      - Tables:
          - GraphTable: api/graphtable.md
          - NodesTable: api/nodestable.md
          - EdgesTable: api/edgestable.md
          - BaseTable: api/basetable.md
      - Arrays:
          - NumArray: api/numarray.md
          - NodesArray: api/nodesarray.md
          - EdgesArray: api/edgesarray.md
      - Matrices:
          - GraphMatrix: api/graphmatrix.md
  - Appendices:
      - Overview: appendices/index.md
      - Glossary: appendices/glossary.md
      - Design Decisions: appendices/design-decisions.md
      - Performance Cookbook: appendices/performance-cookbook.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/rollingstorms/groggy