ontograph/mkdocs.yml at main · saezlab/ontograph · 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
site_name: ontograph
site_url: https://saezlab.github.io/ontograph
theme:
    logo: assets/logo_ontograph.png
    name: material
    font:
        text: Lato
        code: Roboto Mono
    features:
    -   content.code.copy
    -   content.action.edit
    -   navigation.tabs
    -   navigation.instant
    -   navigation.footer
    palette:
    -   scheme: default
        primary: teal
        accent: light blue
        toggle:
            icon: material/toggle-switch
            name: Switch to dark mode
    -   scheme: slate
        primary: teal
        accent: light blue
        toggle:
            icon: material/toggle-switch-off
            name: Switch to light mode

#=======    Website Navigation settings   =====
nav:
-   Home: index.md

-   About:
    -   Project: ontograph-project/project.md
    -   Design philosophy: ontograph-project/design-philosophy.md
    -   Use Cases: ontograph-project/use-cases.md
    -   About: about.md

-   Get Started:
    -   Installation: installation.md
    -   Quickstart: learn/tutorials/quickstart.md

-   Learn:
    -   Tutorials:
        -   Basics: learn/tutorials/tutorial0001_basics.md
        -   HowTo / FAQ:
            -   learn/guides/index.md

-   Explanations:
    -   learn/explanation/index.md

-   Reference:
    -   API Documentation:
        -   Ontograph client:
            -   Client Catalog: reference/source/ontograph/client-catalog.md
            -   Client Ontology: reference/source/ontograph/client-ontology.md
        -   Modules:
            -   downloader: reference/source/ontograph/downloader.md
            -   loader: reference/source/ontograph/loader.md
            -   models: reference/source/ontograph/models.md
            -   queries:
                -   navigator: reference/source/ontograph/queries/navigator.md
                -   relations: reference/source/ontograph/queries/relations.md
                -   introspection: reference/source/ontograph/queries/introspection.md
-   Community:
    -   Events: community/events/derse_26.md
    -   Join Us: community/index.md
    -   Where to Start: community/contribute.md
    -   Contribute to the Documentation: community/contribute-docs.md
    -   Contribute to the Code Base: community/contribute-codebase.md


#=======    Extension settings (sorted alphabetically)  =====
markdown_extensions:
-   admonition
-   attr_list
-   md_in_html
  #----- Python Markdown Extensions
-   pymdownx.blocks.caption
-   pymdownx.details
-   pymdownx.emoji:
        emoji_index: !!python/name:material.extensions.emoji.twemoji
        emoji_generator: !!python/name:material.extensions.emoji.to_svg
-   pymdownx.highlight: # Note: list of Pygments: https://pygments.org/docs/lexers/
        anchor_linenums: true
        line_spans: __span
        pygments_lang_class: true
-   pymdownx.inlinehilite
-   pymdownx.snippets
-   pymdownx.superfences:
        custom_fences:
        -   name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format
-   pymdownx.tabbed:
        alternate_style: true

#=======    Plugins    =====
plugins:
-   search
-   mkdocstrings:
        default_handler: python
        handlers:
            python:
                options:
                    annotations_path: brief
                    docstring_style: google
                    heading_level: 3
                    modernize_annotations: true
                    show_category_heading: true
                    show_object_full_path: false
                    show_root_toc_entry: true
                    show_signature: true
                    show_signature_annotations: false
                    signature_crossrefs: true


copyright: © Copyright 2021-2025, Saez-lab development team.