generator_builder/mkdocs.yml at main · pjritee/generator_builder · 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
site_name: Generator Builder
site_description: Generator factory utilities and helpers for creating reusable Python generator components
site_author: Peter Robinson
repo_url: https://github.com/pjritee/generator_builder
repo_name: pjritee/generator_builder
edit_uri: edit/main/docs/

theme:
  name: readthedocs

plugins:
  - search

nav:
  - Home: index.md
  - Guide:
    - Getting Started: guide/getting_started.md
    - Core Concepts: guide/concepts.md
    - Usage Examples: guide/examples.md
  - API Reference:
    - Generator Builder: api/generator_builder.md
    - Waveforms: api/waveforms.md
    - Generator Visualizer: api/generator_visualizer.md
  - Contributing: CONTRIBUTING.md
  - License: LICENSE.md

markdown_extensions:
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - tables
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pjritee/generator_builder

copyright: Copyright &copy; 2026 Peter Robinson. MIT License.