op_system/mkdocs.yml at main · ACCIDDA/op_system · 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
---
# Site information
site_name: op_system Documentation
site_url: https://accidda.github.io/op_system/

# Repository information
repo_name: ACCIDDA/op_system
repo_url: https://github.com/ACCIDDA/op_system
edit_uri: ''

# Theme information
theme:
  name: material
  custom_dir: overrides

# Plugins
plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            merge_init_into_class: true
            heading_level: 2

# Extras
extra:
  version:
    provider: mike

# Markdown extensions
markdown_extensions:
  - toc:
      permalink: true
      toc_depth: 4
  - attr_list

# Navigation structure
nav:
  - Home: index.md
  - Development:
      - Creating A Release: development/creating-a-release.md
  - Guides:
      - Getting Started: guides/getting-started.md
  - API Reference:
      - OP System: api-reference/op-system.md
      - Compile: api-reference/compile.md
      - Specs: api-reference/specs.md