okcourse/mkdocs.yml at main · mmacy/okcourse · 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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
site_name: OK Courses
site_author: Marsh Macy
site_description: A library that generates courses containing lectures on any topic by using AI. They're not great, but they're OK.
site_url: https://mmacy.github.io/okcourse/
repo_name: okcourse
repo_url: https://github.com/mmacy/okcourse
edit_uri: edit/main/docs/
watch: [CONTRIBUTE.md, LICENSE, README.md, src/okcourse, examples]

theme:
  name: material
  icon:
    logo: material/lectern
    repo: fontawesome/brands/git-alt
    icon: material/lectern

  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: grey
      accent: orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: grey
      accent: orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  font:
    text: Inter
    code: Chivo Mono

  features:
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - header.autohide
    - search.share
    - search.suggest
    - toc.follow

    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking

markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - md_in_html
  - pymdownx.details
  - 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:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true

plugins:
  - search
  - gen-files:
      scripts:
        - scripts/gen_ref_docs.py
  - literate-nav:
      nav_file: SUMMARY.md
  - git-revision-date-localized:
      enable_creation_date: true
  - git-committers:
      repository: mmacy/okcourse
      branch: main
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          import:
            - https://docs.python.org/3/objects.inv
            - https://docs.pydantic.dev/2.10/objects.inv
            - https://mmacy.github.io/openai-python/latest/objects.inv
          options:
            extensions:
              - griffe_pydantic:
                  schema: true
            docstring_options:
              ignore_init_summary: true
              summary: true
            docstring_section_style: table
            docstring_style: google
            filters: ["!^_"]
            heading_level: 3
            inherited_members: false
            merge_init_into_class: true
            separate_signature: true
            show_bases: false
            show_if_no_docstring: true
            show_root_full_path: false
            show_root_heading: false
            show_signature_annotations: true
            show_source: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true
            unwrap_annotated: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/mmacy
  analytics:
    provider: google
    property: G-C3097XSQHR
    feedback:
      title: Is this doc helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This is a good doc
          data: 1
          note: >-
            Yay! Thanks.
        - icon: material/emoticon-sad-outline
          name: This doc needs work
          data: 0
          note: >-
            Oh no! <a href="https://github.com/mmacy/okcourse/issues/new/?title=[doc-feedback]%20{title}%20-%20https://mmacy.github.io/okcourse{url}&body=%3C!--%20Tell%20us%20about%20your%20doc%20issue%20here%20-%20the%20more%20detail%20the%20better!%20--%3E" target="_blank" rel="noopener">What's wrong with it?</a>

nav:
  - Introduction:
      - index.md
      - Get started: get-started.md
      - Examples: examples/index.md
      - API reference: reference/index.md
      - Roadmap: roadmap.md
      - Contribute: contribute.md
      - License: license.md
  - Examples: examples/
  - API reference: reference/