PYRAI/mkdocs.yml at main · mg905/PYRAI · 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
site_name: PyRai Documentation
site_description: Python library for AI development
site_author: PyRai Team
site_url: https://docs.pyrai.xyz

repo_name: pyrai/pyrai
repo_url: https://github.com/pyrai/pyrai
edit_uri: edit/main/docs/

theme:
  name: material
  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
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [pyrai]
          options:
            show_source: true
            show_root_heading: true
            show_category_heading: true
            show_if_no_docstring: true
  - git-revision-date-localized:
      type: datetime
  - minify:
      minify_html: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - footnotes
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Configuration: getting-started/configuration.md
  - User Guide:
    - Basic Usage: user-guide/basic-usage.md
    - Advanced Features: user-guide/advanced-features.md
    - Best Practices: user-guide/best-practices.md
  - API Reference:
    - Core: api/core.md
    - Models: api/models.md
    - Utils: api/utils.md
  - Development:
    - Contributing: development/contributing.md
    - Development Setup: development/setup.md
    - Code Style: development/code-style.md
  - About:
    - License: about/license.md
    - Changelog: about/changelog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pyrai/pyrai
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pyrai
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/pyrai/pyrai