SEF/mkdocs.yml at main · matte67/SEF · 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
site_name: SEF Core Documentation
site_url: https://NoNamedeo.github.io/SEF/
site_description: Public contracts and integration guides for the SEF core package.
docs_dir: docs
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            docstring_section_style: table
            members_order: source
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            separate_signature: true
nav:
  - Home: index.md
  - Overview: overview.md
  - Getting Started: getting-started.md
  - Public API: public-api.md
  - Configuration: configuration.md
  - Registry: registry.md
  - Plugin Authoring: plugin-authoring.md
  - Plugin Metadata: plugin-metadata.md
  - Streaming Runtime: streaming-runtime.md
  - Error Handling: error-handling.md
  - Dependency Plan: dependency-management-plan.md
  - Versioning: versioning.md
  - Examples: examples.md
  - Reference:
      - Component Contracts: reference/component-contracts.md
      - Data and Artifacts: reference/data-and-artifacts.md
      - Pipeline Runtime: reference/pipeline-runtime.md
      - Error Model: reference/errors.md
      - Generated API:
          - Overview: reference/generated-api.md
          - Core Package: reference/api-core.md
          - Pipeline Package: reference/api-pipeline.md
          - Interfaces Package: reference/api-interfaces.md
          - Artifacts Package: reference/api-artifacts.md
          - Plugins Package: reference/api-plugins.md
          - Visualization Package: reference/api-visualization.md
          - Events Package: reference/api-events.md
          - Realtime Package: reference/api-realtime.md
  - Single-Page Contracts: public-contracts.md