am4/mkdocs.yml at master · abc8747/am4 · 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
site_name: am4
site_description: Discord bot and various utilities for the game Airline Manager 4.
repo_name: abc8747/am4
repo_url: https://github.com/abc8747/am4
site_url: https://abc8747.github.io/am4/
nav:
  - Home: 'index.md'
  - Development:
    - Quickstart: 'development/quickstart.md'
    - Core: 'development/core.md'
    - Web API: 'development/web-api.md'
    - Discord Bot: 'development/discord-bot.md'
  - Guide:
    - Preface: 'guides/preface.md'
    - Mathematical Modelling: 'guides/modelling.md'
    - Aircraft Configuration: 'guides/configuration.md'
    - Contribution Strategy: 'guides/contribution.md'
    - Demand: 'guides/demand.md'
  - Quick Reference: 'quick_reference.md'
  - Formulae: 'formulae.md'
  - API Reference:
    - Core:
      - Aircraft: 'api/utils/aircraft.md'
      - Airport: 'api/utils/airport.md'
      - Demand: 'api/utils/demand.md'
      - Route: 'api/utils/route.md'
      - Ticket: 'api/utils/ticket.md'
      - Game: 'api/utils/game.md'
    - Web API: 'api/web-api.md'
    - Database: 'api/db.md'
    - Bot: 'api/bot.md'
  - TOS: 'tos.md'

theme:
  name: material
  features:
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - navigation.expand
    - navigation.footer
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - social
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src/am4/utils/stubs, src/am4]
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://discordpy.readthedocs.io/en/latest/objects.inv
            # - https://docs.pydantic.dev/objects.inv
            - https://fastapi.tiangolo.com/objects.inv
          options:
            inherited_members: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            unwrap_annotated: true
            merge_init_into_class: true
            docstring_section_style: table
            signature_crossrefs: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true

            show_root_heading: true
            show_root_full_path: false
            show_source: false
            summary: true
            show_submodules: true
            docstring_style: sphinx
            find_stubs_package: true

            filters:
              - "!__name__"
              - "!__module__"
              - "!__all__"
              # pybind enums
              - "!__members__"
              - "!__repr__"
              - "!__eq__"
              - "!__getstate__"
              - "!__hash__"
              - "!__index__"
              - "!__int__"
              - "!__ne__"
              - "!__setstate__"
              - "!__str__"
      enable_inventory: true

markdown_extensions:
- abbr
- attr_list
- admonition
- footnotes
- md_in_html
- pymdownx.blocks.admonition
- pymdownx.blocks.details
- pymdownx.blocks.tab:
    alternate_style: true
    slugify: !!python/object/apply:pymdownx.slugs.slugify
      kwds:
        case: lower
- pymdownx.details
- pymdownx.tilde
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
    pygments_lang_class: true
- pymdownx.magiclink
- pymdownx.snippets:
    base_path: docs/assets/scripts
- pymdownx.superfences
- pymdownx.tabbed:
    alternate_style: true
    slugify: !!python/object/apply:pymdownx.slugs.slugify
      kwds:
        case: lower
- pymdownx.tasklist:
    custom_checkbox: true
- toc:
    permalink: "¤"
- pymdownx.arithmatex:
    generic: true

extra_javascript:
  - assets/js/katex.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js

extra_css:
  - assets/css/main.css
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css

extra:
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/4tVQHtf
      name: Airline Manager 4 Discord
    - icon: fontawesome/brands/github
      link: https://github.com/abc8747/am4
      name: Source code