phased-array-systems/mkdocs.yml at main · jman4162/phased-array-systems · 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
162
163
164
165
166
167
168
169
site_name: phased-array-systems
site_description: Phased array antenna system design, optimization, and visualization for wireless communications and radar applications
site_url: https://jman4162.github.io/phased-array-systems
repo_url: https://github.com/jman4162/phased-array-systems
repo_name: jman4162/phased-array-systems
copyright: Copyright &copy; 2024 phased-array-systems contributors

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
  icon:
    repo: fontawesome/brands/github
  logo: https://raw.githubusercontent.com/jman4162/phased-array-systems/main/docs/assets/logo.svg
  favicon: https://raw.githubusercontent.com/jman4162/phased-array-systems/main/docs/assets/favicon.ico

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            docstring_style: google
            docstring_section_style: spacy
            merge_init_into_class: true
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
  - mkdocs-jupyter:
      include_source: true
      execute: false

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - def_list
  - toc:
      permalink: true
      toc_depth: 3

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/jman4162/phased-array-systems
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/phased-array-systems/
  version:
    provider: mike
  analytics:
    provider: google
    property: G-XXXXXXXXXX

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - Installation: getting-started/installation.md
    - Quickstart: getting-started/quickstart.md
    - Core Concepts: getting-started/concepts.md
  - User Guide:
    - user-guide/index.md
    - Architecture Configuration: user-guide/architecture.md
    - Scenarios: user-guide/scenarios.md
    - Requirements: user-guide/requirements.md
    - Link Budget Modeling: user-guide/link-budget.md
    - Radar Detection: user-guide/radar-detection.md
    - Trade Studies: user-guide/trade-studies.md
    - Pareto Analysis: user-guide/pareto-analysis.md
    - Visualization: user-guide/visualization.md
    - Reports: user-guide/reports.md
  - Tutorials:
    - tutorials/index.md
    - Communications Trade Study: tutorials/comms-trade-study.md
    - Radar Detection Trade: tutorials/radar-detection-trade.md
    - Config-Driven Workflow: tutorials/config-driven-workflow.md
    - Sensitivity Analysis: tutorials/sensitivity-analysis.md
  - CLI Reference:
    - cli/index.md
    - pasys run: cli/run.md
    - pasys doe: cli/doe.md
    - pasys report: cli/report.md
    - pasys pareto: cli/pareto.md
  - API Reference:
    - api/index.md
    - Architecture: api/architecture.md
    - Scenarios: api/scenarios.md
    - Requirements: api/requirements.md
    - Models:
      - api/models/index.md
      - Antenna: api/models/antenna.md
      - Communications: api/models/comms.md
      - Radar: api/models/radar.md
      - Digital: api/models/digital.md
      - RF: api/models/rf.md
      - SWaP-C: api/models/swapc.md
    - Trades: api/trades.md
    - Visualization: api/viz.md
    - I/O: api/io.md
    - Reports: api/reports.md
  - Theory:
    - theory/index.md
    - Phased Array Fundamentals: theory/phased-arrays.md
    - Link Budget Equations: theory/link-budget-equations.md
    - Radar Equation: theory/radar-equation.md
    - Pareto Optimization: theory/pareto-optimization.md
  - Contributing: contributing.md
  - Changelog: changelog.md
  - FAQ: faq.md