tripper/mkdocs.yml at master · EMMC-ASBL/tripper · 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
site_name: "Tripper"
site_description: Documentation for the Tripper package
site_url: https://EMMC-ASBL.github.io/tripper
copyright: Copyright &copy; 2022-2025 SINTEF

theme:
  name: material
  palette:
    scheme: default
    primary: cyan
    accent: teal
  icon:
    repo: fontawesome/brands/github
    logo: material/library-shelves
  favicon: assets/images/favicon.png
  language: en
  features:
    - navigation.instant
    - navigation.top
    - content.tabs.link

repo_name: "tripper"
repo_url: "https://github.com/EMMC-ASBL/tripper"
edit_uri: ""

extra:
  social:
    - icon: fontawesome/brands/square-github
      link: https://github.com/EMMC-ASBL
      name: "EMMC-ASBL on GitHub"
  version:
    provider: mike
    default: latest

extra_css:
  - css/reference.css

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.highlight:
      use_pygments: true
      pygments_lang_class: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.caret
  - pymdownx.tilde
  - pymdownx.keys
  - toc:
      permalink: true

exclude_docs: |
  ../datadoc/datadoc.py


plugins:
  - search:
      lang: en
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_root_heading: false
            show_root_toc_entry: true
            show_root_full_path: true
            show_object_full_path: false
            show_category_heading: false
            show_if_no_docstring: false
            show_source: true
            show_bases: true
            group_by_category: true
            heading_level: 2
            filters:
              - "!^_[^_]"
              - "^__init__$"
            members: null
            inherited_members: false
            docstring_style: google
            docstring_options:
              replace_admonitions: true
  - awesome-pages
  - gh-admonitions

nav:
  - Home: index.md
  - Tutorial: tutorial.md
  - Backend discovery: backend_discovery.md
  - Tools:
    - datadoc: tools/datadoc.md
  - Data documentation:
    - Introduction: datadoc/introduction.md
    - Documenting a resource: datadoc/documenting-a-resource.md
    - Documenting abstract resources: datadoc/classdoc.md
    - Searching for and fetching resources: datadoc/fetching-resources-from-a-triplestore.md
    - Customisation: datadoc/customisation.md
    - Predefined prefixes: datadoc/prefixes.md
    - Predefined keywords: datadoc/keywords.md
  - Units and quantities: units/units.md
  - Session: session.md
  - ... | api_reference/**
  - For developers: developers.md
  - Known issues: known-issues.md
  - Changelog: CHANGELOG.md
  - License: LICENSE.md

watch:
  - tripper

#validation:
#  omitted_files: warn
#  absolute_links: warn  # Or 'relative_to_docs' - new in MkDocs 1.6
#  unrecognized_links: warn
#  anchors: warn  # New in MkDocs 1.6

validation:
  links:
    absolute_links: relative_to_docs
    anchors: warn
    unrecognized_links: warn