opal-admin/mkdocs.yml at main · opalmedapps/opal-admin · 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
# SPDX-FileCopyrightText: Copyright (C) 2022 Opal Health Informatics Group at the Research Institute of the McGill University Health Centre <john.kildea@mcgill.ca>
#
# SPDX-License-Identifier: AGPL-3.0-or-later

# Project information
site_name: Backend
site_url: https://opalmedapps.github.io/opal-admin
site_author: Opal Health Informatics Group (O-HIG)

# Repository
repo_name: opalmedapps/opal-admin
repo_url: https://github.com/opalmedapps/opal-admin

# Copyright
copyright: Copyright &copy; Opal Health Informatics Group (O-HIG)

# Content
nav:
  - Home: index.md
  - Architecture: architecture.md
  - Apps:
      - App Structure: apps/structure.md
      - Caregivers: apps/caregivers.md
      - Health Data: apps/health_data.md
      - Patients: apps/patients.md
      - Users: apps/users.md
      - Questionnaires: apps/questionnaires.md
  - Database:
      - Migrations: database/migrations.md
      - Legacy DB Setup: database/legacy_db.md
  - REST API:
      - Authentication: authentication.md
  - Custom Permissions: standard_and_custom_permissions.md
  - Translation: translation.md
  - Code Reference: reference/

# Configuration
theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    # TODO: host locally
    # see: https://fonts.google.com/specimen/Roboto
    # see: https://fonts.google.com/specimen/Roboto+Mono
    text: Roboto
    code: Roboto Mono
  language: en
  icon:
    logo: material/book-open-page-variant
    # repo: fontawesome/brands/gitlab
  features:
    # - navigation.instant
    # - navigation.tabs
    - navigation.top
    - search.highlight

# Plugins
plugins:
  - search
  - autorefs
  # generate code reference documents from code base
  - gen-files:
      scripts:
        - docs/gen_reference_nav.py
  # auto-generate navigation structure for code reference
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings:
      handlers:
        python:
          inventories:
            # import Sphinx objects inventories to support referencing other elements in docs
            - https://docs.python.org/3/objects.inv
            - https://docs.djangoproject.com/en/dev/_objects/
            - https://django-modeltranslation.readthedocs.io/en/latest/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv

# Extensions
markdown_extensions:

  # Python Markdown
  - admonition
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true

  # Python Markdown Extensions
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

watch:
  - README.md
  - opal/
  - config/