psPlotKit/mkdocs.yml at main · avdudchenko/psPlotKit · 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
site_name: psPlotKit
site_description: A Python plotting and analysis toolkit for parameter sweep and loop tool simulation data.
site_url: https://avdudchenko.github.io/psPlotKit/
repo_url: https://github.com/avdudchenko/psPlotKit
repo_name: avdudchenko/psPlotKit

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            members_order: source
            heading_level: 2

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - admonition
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - User Guide:
      - Data Import: guide/data-import.md
      - Data Management: guide/data-management.md
      - Expressions: guide/expressions.md
      - Costing: guide/costing.md
      - Plotting: guide/plotting.md
  - API Reference:
      - Data Manager:
          - PsDataImport: api/data_importer.md
          - PsData: api/ps_data.md
          - PsDataManager: api/ps_data_manager.md
          - PsCosting: api/ps_costing.md
          - PsDataExporter: api/ps_data_exporter.md
          - Expressions: api/ps_expression.md
      - Data Plotter:
          - FigureGenerator: api/fig_generator.md
          - linePlotter: api/line_plotter.md
          - boxPlotter: api/box_plotter.md
          - BreakDownPlotter: api/break_down_plotter.md
          - MapPlotter: api/map_plotter.md
          - Plot Data Storage: api/plot_data_storage.md
      - Utilities:
          - Logger: api/logger.md
          - Utility Functions: api/util_funcs.md
  - Examples:
      - Cost Breakdown Plotting: examples/cost-plotting.md
      - Simple Bar Plots: examples/bar-plots.md