forging-blocks/mkdocs.yml at main · forging-blocks-org/forging-blocks · 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
site_name: ForgingBlocks
site_description: Composable toolkit for clean, testable, and maintainable Python applications
site_author: ForgingBlocks Org
site_url: https://forging-blocks-org.github.io

repo_url: https://github.com/forging-blocks-org
repo_name: forging-blocks-org/forging-blocks
edit_uri: edit/main/docs/

extra_css:
  - assets/css/theme.css
  - assets/css/mermaid-theme.css

theme:
  name: material
  language: en
  palette:
    scheme: slate
    primary: orange
    accent: amber
  highlightjs: false
  logo: assets/logo.png
  favicon: assets/favicon.ico
  features:
    - navigation.tabs
    - navigation.instant
    - navigation.sections
    - toc.follow
    - content.code.copy
    - content.action.edit
    - content.tabs.link

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - nl2br
  - toc:
      permalink: true
  - pymdownx.snippets:
      base_path: [., docs]
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - pymdownx.highlight:
      use_pygments: true
      pygments_style: gruvbox-dark
      noclasses: false
      pygments_lang_class: true
      anchor_linenums: true
      line_spans: __span

nav:
  - Home: index.md

  - Guide:
      - Introduction: guide/index.md
      - Getting Started: guide/getting-started.md
      - Testing: guide/testing.md
      - Example Tests: guide/example_tests.md
      - Examples: guide/examples.md
      - Principles: guide/principles.md
      - Architecture Overview: guide/architecture-overview.md
      - Recommended Blocks Structure: guide/recommended_blocks_structure.md

  - Reference:
      - Overview: reference/index.md
      - Foundation: reference/foundation.md
      - Domain: reference/domain.md
      - Application: reference/application.md
      - Infrastructure: reference/infrastructure.md
      - Presentation: reference/presentation.md
      - Testing: reference/testing.md

  - Architectural Styles:
      - Overview: architectural-styles/index.md
      - Clean Architecture: architectural-styles/clean-architecture.md
      - Hexagonal Architecture: architectural-styles/hexagonal-architecture.md
      - Layered Architecture: architectural-styles/layered-architecture.md
      - CQRS: architectural-styles/cqrs.md
      - Event-Driven: architectural-styles/event-driven.md

  - Contributing:
      - Overview: contributing/index.md
      - Contribution Guide: contributing/contributing.md
      - Docs Conventions: contributing/docs-conventions.md
      - Release Guide: contributing/release-guide.md

  - License: LICENSE.md

plugins:
  - search
  - autorefs
  - section-index
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            members_order: source
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true