oris/mkdocs.yml at dev · DevStrikerTech/oris · 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
# Oris documentation — built with MkDocs Material (GitHub Pages)
site_name: Oris
site_description: >-
  Responsible AI pipeline runtime for Python — YAML pipelines, guards, traces, and SafeRunner.
site_author: Oris Contributors
site_url: https://devstrikertech.github.io/oris/
repo_url: https://github.com/DevStrikerTech/oris
repo_name: DevStrikerTech/oris
edit_uri: edit/dev/docs/

docs_dir: docs
site_dir: site

theme:
  name: material
  language: en
  logo: images/oris_logo.png
  favicon: images/oris_logo.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - content.code.copy
    - content.action.edit
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - toc.follow

extra:
  version: 0.7.2
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/DevStrikerTech/oris
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/oris-ai/

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

nav:
  - Introduction: index.md
  - Get started:
      - Installation: get-started/installation.md
      - Quickstart: get-started/quickstart.md
  - Concepts:
      - Overview: concepts/overview.md
      - Pipelines & YAML: concepts/pipelines.md
      - Components & providers: concepts/components.md
      - RAI & observability: concepts/rai-tracing.md
  - Guides:
      - CLI reference: guides/cli.md
      - SafeRunner: guides/safe-runner.md
      - Runs, output & traces: guides/output.md
  - Examples: examples/index.md
  - Community:
      - Contributing: development/contributing.md
      - Security: development/security.md
      - Code of Conduct: development/code-of-conduct.md

plugins:
  - search

copyright: Copyright &copy; Oris Contributors — MIT License