pyjelly/mkdocs.yml at main · Jelly-RDF/pyjelly · 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
site_name: pyjelly
site_description: pyjelly is a Python implementation of the Jelly RDF streaming protocol.
site_url: https://jelly-rdf.github.io/pyjelly/

plugins:
  - search
  - mike
  - macros:
      module_name: docs/env
  - git-revision-date-localized:
      enable_creation_date: true
  - autorefs
  - markdown-exec
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: true
            heading_level: 3
            # https://mkdocstrings.github.io/python/usage/#configuration/
            docstring_style: numpy
            docstring_options:
              ignore_init_summary: true
              trim_doctest_flags: false
            members_order: source
            merge_init_into_class: true
            parameter_headings: true
            show_submodules: true
            show_inheritance_diagram: false
            show_signature_annotations: false
            signature_crossrefs: true
            line_length: 60
            show_labels: false
            show_symbol_type_heading: false
            show_symbol_type_toc: true
            summary: true
          paths: [pyjelly/]
          inventories:
            - http://docs.python.org/3/objects.inv
            - https://rdflib.readthedocs.io/en/stable/objects.inv

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - footnotes
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

repo_url: https://github.com/Jelly-RDF/pyjelly
repo_name: Jelly-RDF/pyjelly
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: docs/overrides
  features:
    # Behave like an SPA
    - navigation.instant
    - navigation.instant.progress
    # Update anchors in the address bar
    - navigation.tracking
    - navigation.top
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit

  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-3
        name: Switch to light mode

  logo: assets/jelly_white.png
  favicon: assets/jelly_color.png
  icon:
    repo: fontawesome/brands/github

extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Jelly-RDF/pyjelly
      name: pyjelly on GitHub
    - icon: fontawesome/brands/discord
      link: https://discord.gg/A8sN5XwVa5
      name: Community Discord server

nav:
  - Home : "index.md"
  - User guide:
      - Getting started (RDFLib): "getting-started.md"
      - Overview and supported features: "overview.md"
      - Generic API (no RDFLib): "generic-sink.md"
      - Neo4j: "rdflib-neo4j-integration.md"
      - NetworkX: "networkx-integration.md"
  - API reference: "api.md"
  - Contributing:
      - "contributing/index.md"
      - Code of conduct: "contributing/code_of_conduct.md"
  - Releases: "https://github.com/Jelly-RDF/pyjelly/releases"
  - Licensing and citation: "https://w3id.org/jelly/dev/licensing"
  - Back to main Jelly docs ↩: "https://w3id.org/jelly/"