auto_dev/mkdocs.yml at main · ExploreLabsxyz/auto_dev · 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
site_name: auto_dev
site_url: https://8ball030.github.io/auto_dev
repo_url: https://github.com/8ball030/auto_dev
repo_name: 8ball030/auto_dev
#strict: true

hooks:
  - scripts/generate_command_docs.py

# Optimized navigation structure
nav:
  - Home: index.md
  - Installation: installation.md
  - Usage:
    - Overview: usage.md
    - FSM: fsm.md
    - OpenAPI: openapi.md
    - DAO: dao.md
  - Commands:
    - run: commands/run.md
    - create: commands/create.md
    - lint: commands/lint.md
    - publish: commands/publish.md
    - test: commands/test.md
    - improve: commands/improve.md
    - release: commands/release.md
    - metadata: commands/metadata.md
    - fmt: commands/fmt.md
    - scaffold: commands/scaffold.md
    - deps: commands/deps.md
    - convert: commands/convert.md
    - repo: commands/repo.md
    - fsm: commands/fsm.md
    - augment: commands/augment.md
  - Contributing: contributing.md
  - Changelog: changelog.md

theme:
  name: material
  language: en
  #logo: assets/logo.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      accent: blue
      primary: blue_grey
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      accent: blue
      primary: blue_grey
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    code: Roboto Mono
    text: Source Sans Pro
  features:
    - navigation.instant
    - navigation.expand
    - navigation.sections
    - navigation.top
    - toc.follow
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - admonition
  - toc:
      permalink: true
      toc_depth: 3
      baselevel: 1
  - attr_list
  - pymdownx.snippets:
      base_path: .
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde

plugins:
  - search
  - include-markdown
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          selection:
            docstring_style: sphinx
          rendering:
            show_root_heading: true
            show_source: false
            show_signature_annotations: true
            members_order: source
            docstring_section_style: list
          paths: [auto_dev]

extra_css:
  - stylesheets/extra.css
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/8ball030/auto_dev
      name: Github
    - icon: material/email
      link: "mailto:8ball030@gmail.com"