sparser/mkdocs.yaml at main · pentergust/sparser · 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
site_name: SPlatform
copyright: 2020 - 2025 Miroq
repo_url: https://git.miroq.ru/splatform/telegram
repo_name: Sparser
edit_uri: _edit/main/docs/

nav:
  - Home:
      - index.md
      - install.md
      - contribute.md
      - develop.md
      - changelog.md
  - Usage:
      - usage/index.md
      - usage/start.md
      - usage/class.md
      - usage/schedule.md
      - usage/query.md
      - usage/notify.md
      - usage/updates.md
      - usage/counters.md
      - usage/next.md
  - Wrappers:
      - wrappers/index.md
      - wrappers/telegram.md
      - wrappers/cli.md
      - wrappers/vk.md
  - Api:
      - api/index.md
      - api/counter.md
      - api/db.md
      - api/enums.md
      - api/intents.md
      - api/schedule.md
      - api/timetable.md
      - api/updates.md
      - Provider:
          - api/provider/index.md
          - api/provider/base.md
          - api/provider/google.md
      - View:
          - api/view/index.md
          - api/view/base.md
          - api/view/messages.md

  #     - install.md
  #     - contribute.md
  #     - changelog.md

theme:
  name: material
  language: ru
  palette:
    scheme: slate
    primary: teal
    accent: teal
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search.highlight
    - navigation.footer
    - content.action.edit
    - content.code.copy
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: false
            parameter_headings: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docsting_style: 'google'
            docstring_section_style: 'list'
            merge_init_into_class: true
            show_if_no_docstring: true
            show_signature_annotations: true
            signature_crossrefs: true
            members_order: 'source'

markdown_extensions:
  - toc:
      toc_depth: 3
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

options:
  extra:
    generator: false
    social:
      - icon: fontawesome/brands/github
        link: https://codeberg.org/salormoon/
        name: Команда разработчиков проекта
      - icon: fontawesome/brands/telegram
        link: https://t.me/mili_qlaster
        name: Новостной канал проекта