solarfarmer-python-sdk/mkdocs.yml at main · dnv-opensource/solarfarmer-python-sdk · 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
site_name: SolarFarmer Python SDK
site_description: Official Python SDK for DNV SolarFarmer. Build PV plant configurations and run energy calculations.
site_author: DNV
site_url: https://dnv-opensource.github.io/solarfarmer-python-sdk/
copyright: '&copy; 2026 DNV AS. All rights reserved.'
repo_url: https://github.com/dnv-opensource/solarfarmer-python-sdk
docs_dir: docs
site_dir: site

extra:
  pypi_url: https://pypi.org/project/dnv-solarfarmer/
  pypi_name: dnv-solarfarmer
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/dnv-opensource/solarfarmer-python-sdk
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/dnv-solarfarmer/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/feed/hashtag/solarfarmer/
    - icon: fontawesome/solid/envelope
      link: mailto:solarfarmer@dnv.com

theme:
  name: material
  language: en
  logo: 'img/SolarFarmerLogo.png'
  palette:
    - scheme: default
      primary: teal
      accent: deep_orange
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: indigo
      icon: material/brightness-4
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.footer
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight
    - content.tabs.link

markdown_extensions:
  - admonition
  - attr_list
  - codehilite
  - fenced_code
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
  - search
  # - analytics:
  #     provider: google
  #     property: G-  # Placeholder - replace with actual GA4 Property ID
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            merge_init_into_class: true
            show_source: false
            separate_signature: true
            extra:
              line_by_line: false
              show_bases: false

nav:
- Home: index.md
- Getting started:
    - Overview: getting-started/index.md
    - Workflow 1 - Load Existing API Files: getting-started/workflow-1-existing-api-files.md
    - Workflow 2 - Design Plants with PVSystem: getting-started/workflow-2-pvplant-builder.md
    - Workflow 3 - Advanced Integration: getting-started/workflow-3-plantbuilder-advanced.md
    - Quick Start Examples: getting-started/quick-start-examples.md
    - End-to-End Examples: getting-started/end-to-end-examples.md
- API Reference: api.md
- External Resources:
    - Endpoint definitions:
        - About: https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Endpoints/AboutEndpoint.html
        - ModelChain: https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Endpoints/ModelChainEndpoint.html
        - ModelChainAsync: https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Endpoints/ModelChainAsyncEndpoint.html
        - Service: https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Endpoints/ServiceEndpoint.html
        - TerminateModelChainAsync: https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Endpoints/TerminateModelChainAsyncEndpoint.html
    - Tutorials in SolarFarmer docs:
        - ModelChain endpoint tutorial: https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Tutorials/ModelChainEndpointTutorial.html
        - ModelChainAsync endpoint tutorial: https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Tutorials/ModelChainAsyncEndpointTutorial.html
    - Troubleshooting:
        - Validation service: https://mysoftware.dnv.com/download/public/renewables/solarfarmer/manuals/latest/WebApi/Troubleshooting/ValidationService.html
- License: license.md
- Frequently Asked Questions: faq.md