atopile/mkdocs.yml at main · napowderly/atopile · 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
158
159
160
161
site_name: atopile
site_url: https://docs.atopile.io
site_description: >-
  atopile is a language and toolchain to describe electronic circuit boards with code.
  By replacing the point and click schematic interface with code, we introduce software
  development workflows like reuse, validation and automation to the world of electronics.
  Join us in this adventure!

nav:
- Getting Started:
  - index.md
  - quickstart.md
  - CHANGELOG.md
  - Tutorial:
    - tutorial/1-the-ato-language.md
    - tutorial/2-the-ato-compiler.md
    - tutorial/3-ato-create-component.md
    - tutorial/4-packages.md
    - tutorial/5-layout.md
  - Guides:
    - guides/installation.md
    - guides/git.md
    - guides/faebryk.md
  - Reference:
    - reference/attributes.md
    - reference/config.md
- Development:
  - development.md
- Packages: https://packages.atopile.io
- Example Projects:
  - spin.md
  - swoop.md
plugins:
- search
- mkdocstrings:
    handlers:
      python:
        paths: [src]
        options:
          extensions:
          - griffe_typingdoc
          show_root_heading: true
          show_if_no_docstring: true
          inherited_members: true
          members_order: source
          separate_signature: true
          unwrap_annotated: true
          filters:
          - '!^_'
          merge_init_into_class: true
          docstring_section_style: spacy
          signature_crossrefs: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true
- mike
- atopile_json_schema

repo_name: atopile/atopile
repo_url: https://github.com/atopile/atopile

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: atopile
      repo: atopile
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

theme:
  features:
  - navigation.tabs
  - navigation.sections
  - toc.follow
  - navigation.footer
  - header.autohide
  - announce.dismiss
  icon:
    repo: fontawesome/brands/git-alt
  name: material
  custom_dir: docs/overrides
  logo: assets/logo/emblem.svg
  favicon: assets/logo/emblem.svg
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference

extra:
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/XQ34te6NZN
    - icon: fontawesome/brands/github
      link: https://github.com/atopile/atopile
    - icon: fontawesome/solid/paper-plane
      link: "mailto:founders@atopile.io"
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/atopile_io
  version:
    provider: mike
    default: latest
    alias: true
  generator: false

extra_css:
  - stylesheets/extra.css