AMMICO/mkdocs.yml at main · ssciwr/AMMICO · 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
site_name: AMMICO
site_description: AI-based Media and Misinformation Content Analysis Tool
site_url: https://ssciwr.github.io/AMMICO/
repo_url: https://github.com/ssciwr/AMMICO
repo_name: ssciwr/AMMICO

theme:
  name: material
  features:
    - navigation.sections
    - navigation.indexes
    - search.suggest
    - search.highlight
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google

nav:
  - Home: index.md
  - Tutorials:
    - Getting started: tutorials/getting_started.md
    - Image summary and VQA: tutorials/image_summary.md
    - Video summary and VQA: tutorials/video_summary.md
    - Text analysis: tutorials/text.md
    - Multimodal analysis: tutorials/ammico_demo_multimodal_analysis.md
    - Color analysis: tutorials/colors.md
    - Interactive display: tutorials/display.md
  - Modules:
    - Text analysis: modules/text.md
    - Image summary and VQA: modules/image_summary.md
    - Video summary and VQA: modules/video_summary.md
    - Color analysis: modules/colors.md
    - Interactive display: modules/display.md
  - More information:
    - Set up credentials for Google Cloud API: set_up_credentials.md
    - FAQ: faq.md
  - API Reference: api.md