fhircraft/mkdocs.yml at main · DebuggingMax/fhircraft · 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
site_name: Fhircraft - Pythonic FHIR
site_url: https://github.com/luisfabib/fhircraft
repo_url: https://github.com/luisfabib/fhircraft
repo_name: luisfabib/fhircraft
copyright: Copyright &copy; 2024 - 2026 Luis Fábregas-Ibáñez and contributors

theme:
  icon:
    repo: fontawesome/brands/github
  favicon: assets/images/favicon.png
  logo: assets/logo_white.svg
  name: material
  custom_dir: docs/.overrides
  features:
    - announce.dismiss
    - content.code.copy
    - content.code.annotate
    - navigation.expand
    - navigation.path
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.sections
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: pink
      accent: pink
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: pink
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

extra_css:
  - stylesheets/extra.css
  - stylesheets/mkdocstrings.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/luisfabib/fhircraft
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/fhircraft/

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

plugins:
  - search
  - literate-nav:
      nav_file: SUMMARY.md
  - gen-files:
      scripts:
        - docs/.scripts/gen_ref_pages.py
        - docs/.scripts/gen_credits_page.py
        - docs/.scripts/gen_repo_pages.py
  - mkdocstrings:
      custom_templates: docs/.overrides
      handlers:
        python:
          options:
            docstring_style: google
            members_order: source
            separate_signature: true
            filters: ["!^_"]
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            summary: true
            signature_crossrefs: true
            extensions:
              - griffe_fieldz:
                  include_inherited: true
          import:
            - https://docs.python.org/3/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv
            - https://typing-extensions.readthedocs.io/en/latest/objects.inv