docs/mkdocs.yml at main · ekeel-project/docs · 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
site_name: "EKEEL - Empowering Knowledge Extraction to Empower Learners"
repo_url: https://github.com/orgs/ekeel-project/repositories
repo_name: Github Project
site_url: https://ekeel-project.github.io/docs/

docs_dir: mkdocs
site_dir: docs

theme:
  name: "material"
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to system preference

    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to dark mode

  features:
    - navigation.top  # Keeps navigation bar fixed at the top
    - navigation.tabs  # Use tabs for navigation
    - navigation.instant  # Load pages instantly without reloads
    - content.code.annotate  # Adds code annotations
    - content.code.copy  # Adds copy-to-clipboard button in code blocks
    - content.tooltips  # Enables tooltips for glossary terms

  font:
    text: Source Serif Pro

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences

plugins:
  - mkdocs-pdf
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: numpy
            show_source: true
            show_root_heading: false
  - gen-files:
      scripts:
        - mkdocs/docstring_extractor.py
  - literate-nav:
      nav_file: CODE_INDEX.md
  - section-index


nav:
  - Homepage: index.md
  - Deploy:
    - Quickstart: platforms/quickstart.md
    - Local:
      - Annotator: platforms/annotator/install.md
      - Augmentator: platforms/augmentator/install.md
    - Remote:
      - Prerequisites: prerequisites/linux-services.md
      - Codebase Update: remote/pull.md
      - Annotator: platforms/annotator/deploy.md
      - Augmentator: platforms/augmentator/deploy.md
      - Transcriber: platforms/annotator/transcriber/deploy.md
  - Codebase:
    - Introduction: codebase/introduction.md
    - Apps: codebase/
  - Documentation:
    - Mkdocs: prerequisites/mkdocs.md

extra:
  social:
    - icon: fontawesome/brands/twitter
      link: about:void
    - icon: fontawesome/brands/blogger
      link: https://ekeel.dibris.unige.it/