FilesExpand file tree

 db_v4

/

mkdocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

148 lines (147 loc) · 4.92 KB

 db_v4

/

mkdocs.yml

Top

File metadata and controls

• Code
• Blame

148 lines (147 loc) · 4.92 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

site_name: Raphtory Documentation

site_url: !ENV READTHEDOCS_CANONICAL_URL

theme:

name: material

custom_dir: docs/overrides

logo: assets/logo.png

palette:

# Palette toggle for light mode

- media: "(prefers-color-scheme: light)"

scheme: primary

toggle:

icon: material/brightness-4

name: Switch to dark mode

# Palette toggle for dark mode

- media: "(prefers-color-scheme: dark)"

scheme: slate

toggle:

icon: material/brightness-7

name: Switch to light mode

features:

- navigation.tracking

- navigation.instant

- navigation.tabs

- navigation.tabs.sticky

- navigation.footer

- content.tabs.link

- content.code.copy

icon:

repo: fontawesome/brands/github

extra_css:

- stylesheets/extra.css

plugins:

- search:

lang: en

- markdown-exec

- macros:

module_name: docs/scripts/macro

- gen-files:

scripts:

- docs/scripts/gen_docs_pages.py

- literate-nav:

nav_file: SUMMARY.md

- section-index

- mkdocstrings:

handlers:

python:

options:

show_source: false

show_root_heading: true

show_root_full_path: false

show_if_no_docstring: true

allow_inspection: false

docstring_style: google

docstring_options:

returns_type_in_property_summary: true

returns_named_value: false

paths: [ "python/python" ]

inventories:

- https://docs.python.org/3/objects.inv

markdown_extensions:

- admonition

- toc:

permalink: "#"

- pymdownx.details

- attr_list

- md_in_html

- def_list

- pymdownx.emoji:

emoji_index: !!python/name:material.extensions.emoji.twemoji

emoji_generator: !!python/name:material.extensions.emoji.to_svg

- pymdownx.superfences

- pymdownx.blocks.tab:

alternate_style: True

combine_header_slug: True

slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}

- pymdownx.snippets:

base_path: [ ".", "docs/src/" ]

check_paths: true

dedent_subsections: true

- footnotes

- markdown_hide_code

repo_url: https://github.com/pometry/raphtory

repo_name: pometry/raphtory

nav:

- Home: index.md

- User Guide:

- Get started:

- user-guide/getting-started/0_dummy_index.md

- user-guide/getting-started/10_installation.md

- user-guide/getting-started/20_intro.md

- user-guide/getting-started/30_cli.md

- user-guide/getting-started/40_key_concepts.md

- User interface:

- user-guide/user-interface/0_dummy_index.md

- user-guide/user-interface/10_UI_overview.md

- user-guide/user-interface/20_graph_view.md

- Ingestion:

- user-guide/ingestion/0_dummy_index.md

- user-guide/ingestion/1_intro.md

- user-guide/ingestion/2_direct-updates.md

- user-guide/ingestion/3_dataframes.md

- user-guide/ingestion/4_saving.md

- Querying:

- user-guide/querying/0_dummy_index.md

- user-guide/querying/1_intro.md

- user-guide/querying/2_graph-metrics.md

- user-guide/querying/3_node-metrics.md

- user-guide/querying/4_edge-metrics.md

- user-guide/querying/5_properties.md

- user-guide/querying/6_chaining.md

- Graph views:

- user-guide/views/0_dummy_index.md

- user-guide/views/1_intro.md

- user-guide/views/2_time.md

- user-guide/views/3_layer.md

- user-guide/views/4_subgraph.md

- user-guide/views/5_materialize.md

- user-guide/views/6_filtering.md

- Running Algorithms:

- user-guide/algorithms/0_dummy_index.md

- user-guide/algorithms/1_intro.md

- user-guide/algorithms/2_graph-algorithms.md

- user-guide/algorithms/3_node-algorithms.md

- user-guide/algorithms/4_view-algorithms.md

- user-guide/algorithms/5_community_detection.md

- user-guide/algorithms/6_vectorisation.md

- Exporting:

- user-guide/export/0_dummy_index.md

- user-guide/export/1_intro.md

- user-guide/export/2_dataframes.md

- user-guide/export/3_networkx.md

- Making GraphQL queries:

- user-guide/graphql/0_dummy_index.md

- user-guide/graphql/1_intro.md

- user-guide/graphql/2_run-server.md

- user-guide/graphql/3_writing-queries.md

- Temporal graph representations:

- user-guide/persistent-graph/0_dummy_index.md

- user-guide/persistent-graph/1_intro.md

- user-guide/persistent-graph/2_ambiguity.md

- user-guide/persistent-graph/3_views.md

- user-guide/troubleshooting.md

- user-guide/compatibility.md

- Python API: reference/python/

- GraphQL API: reference/graphql/graphql_API.md

- Rust API: https://docs.rs/raphtory/latest/raphtory/

- Pometry: https://www.pometry.com/