physics_sim_edu/mkdocs.yml at master · galbot-ioai/physics_sim_edu · 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
# Physics Simulator Documentation Configuration

########################### Edit these lines for your project #######################
site_name: Physics Simulator Documentation
site_url: https://galbot-ioai.github.io/physics_sim_edu/
repo_name: physics_sim_edu
repo_url: https://github.com/galbot-ioai/physics_sim_edu

########################### Do not modify below this line ###########################
nav:
  - Home: index.md
  - Overview: overview.md
  - Installation and Configuration: installation_and_configuration.md
  - Examples: examples.md
  - API Reference: api.md
  - Troubleshooting: troubleshooting.md
  - License: license.md

theme:
  language: en
  name: material
  logo: image/galbot_white_logo.png
  favicon: image/icon.svg
  icon:
    repo: fontawesome/brands/github
  font:
    code: JetBrains Mono
    text: Inter
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      scheme: default
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to system preference
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.path
    - navigation.top
    - toc.follow
    - toc.integrate
    - search.highlight
    - search.share

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - admonition
  - attr_list
  - md_in_html
  - def_list

copyright: Copyright &copy; 2023-2025 Galbot. All rights reserved.

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            docstring_options:
              trim_doctest_flags: true
            show_source: true
            show_root_heading: true
            show_category_heading: true
            show_if_no_docstring: true
            show_signature_annotations: true
            show_bases: true
            show_submodules: true
            heading_level: 2
            merge_init_into_class: true
            docstring_section_style: table
            members_order: source
            show_signature: true
            extra:
              show_signature_return_annotation: true
          # Add Python path configuration
          paths: [src]

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/galbot-ioai/physics_sim_edu
      name: Physics Simulator on GitHub
    - icon: fontawesome/brands/bilibili
      link: https://space.bilibili.com/3546595559737798?spm_id_from=333.337.search-card.all.click