agent-guy/mkdocs.yml at develop · LaciGit/agent-guy · 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
site_name: Agent-Guy

repo_url: https://github.com/LaciGit/agent-guy
repo_name: agent-guy

nav:
  - Home: index.md
  - Development:
    - Introduction: development.md
    - Vision and Idea: development/vision.md
    - Step 1: development/step1.md
  - Code Reference: reference/
  - About: about.md

plugins:
  - search
  - section-index
  - autorefs
  - tags
  - literate-nav:
      nav_file: SUMMARY.md
  - git-revision-date-localized:
      enable_creation_date: false
      type: timeago
  - git-authors
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
  - mkdocstrings:
      handlers:
        python:
          paths: [agent_guy]
          import:
            - https://docs.python.org/3/objects.inv
            - https://mkdocstrings.github.io/objects.inv
            - https://mkdocstrings.github.io/griffe/objects.inv
          options:
            docstring_style: google
            docstring_options:
              ignore_init_summary: no
            merge_init_into_class: yes
            separate_signature: yes
            show_source: yes
            show_root_full_path: no

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.mark
  - pymdownx.emoji
  - pymdownx.magiclink
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.arithmatex:
      generic: true
  - toc:
      permalink: "¤"
  - footnotes

theme:
  icon:
    repo: fontawesome/brands/github
  name: material
  features:
    - header.autohide
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.footer
    - navigation.instant
    - navigation.instant.progress
    - navigation.instant.prefetch
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  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
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

copyright: Copyright &copy; László Baló
extra:
  social:
    - icon: fontawesome/solid/paper-plane
      link: mailto:laszlo.balo@icloud.com
      name: László Baló
  generator: false