-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathmkdocs.yml
170 lines (163 loc) · 6.44 KB
/
mkdocs.yml
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
site_name: CPLUS QGIS plugin
repo_name: 'ConservationInternational/cplus-plugin'
repo_url: 'https://github.com/ConservationInternational/cplus-plugin'
site_description: CPLUS
site_author: Kartoza
nav:
- Home: index.md
- Users:
- user/index.md
- Quick Start: user/quickstart/index.md
- Guide:
- user/guide/index.md
- Complete Steps and Report: user/guide/complete-steps-and-report.md
- Preparing Data: user/guide/preparing-data.md
- Settings: user/guide/settings.md
- Step 1: user/guide/step-1.md
- Step 2: user/guide/step-2.md
- Step 3: user/guide/step-3.md
- Step 4: user/guide/step-4.md
- Logs: user/guide/logs.md
- Manual:
- user/manual/index.md
- Calculation and Formula: user/manual/calculation-and-formula.md
- Step 1: user/manual/step-1.md
- Step 2: user/manual/step-2.md
- Step 3: user/manual/step-3.md
- Step 4: user/manual/step-4.md
- Logs: user/manual/logs.md
- Settings: user/manual/settings.md
- Scenario File: user/manual/scenario-file.md
- Administrators:
- administrator/index.md
- Guide: administrator/guide/index.md
- Repository: administrator/repository/index.md
- Developers:
- developer/index.md
- Setup: developer/setup/index.md
- Architecture: developer/architecture/index.md
- Documentation: developer/documentation/index.md
- API:
- Core:
- Main: developer/api/core/api_main.md
- Configuration: developer/api/core/api_conf.md
- Processing: developer/api/core/api_tasks.md
- Settings: developer/api/core/api_settings.md
- Utilities: developer/api/core/api_utils.md
- Financials: developer/api/core/api_financials.md
- Carbon: developer/api/core/api_carbon.md
- Reports:
- Comparison Table: developer/api/core/api_report_scenario_comparison_table.md
- Generator: developer/api/core/api_reports_generator.md
- Layout items: developer/api/core/api_reports_layout_items.md
- Manager: developer/api/core/api_reports_manager.md
- Variables: developer/api/core/api_reports_variables.md
- Validation:
- Configurations: developer/api/core/api_validation_configs.md
- Feedback: developer/api/core/api_validation_feedback.md
- Manager: developer/api/core/api_validation_manager.md
- Validators: developer/api/core/api_validation_validators.md
- Models:
- Model base: developer/api/models/api_base.md
- Helpers: developer/api/models/api_helpers.md
- Report: developer/api/models/api_report.md
- Financials: developer/api/models/api_financials.md
- Validation: developer/api/models/api_validation.md
- GUI:
- GUI main: developer/api/gui/api_gui_main.md
- Carbon item model: developer/api/gui/api_carbon_layer_model.md
- Component item model: developer/api/gui/api_component_items.md
- Implementation model editor: developer/api/gui/api_activity_editor_dialog.md
- Implementation model widget: developer/api/gui/api_activity_widget.md
- Items selection dialog: developer/api/gui/api_items_selection_dialog.md
- Map repeat item widget: developer/api/gui/api_map_repeat_item_widget.md
- Model component widget: developer/api/gui/api_model_component_widget.md
- NCS Pathway editor: developer/api/gui/api_ncs_pathway_editor.md
- Pixel Values editor: developer/api/gui/api_pixel_value_editor.md
- Priority layer dialog: developer/api/gui/api_priority_layer.md
- Priority group: developer/api/gui/api_priority_group.md
- Progress dialog: developer/api/gui/api_progress_dialog.md
- Financials:
- NPV PWL manager: developer/api/gui/api_npv_manager_dialog.md
- NPV progress dialog: developer/api/gui/api_npv_progress_dialog.md
- NPV view model: developer/api/gui/api_npv_financial_model.md
- Validation:
- Inspector dialog: developer/api/gui/api_validation_inspector_dialog.md
- Progress dialog: developer/api/gui/api_validation_progress_dialog.md
- Tree items: developer/api/gui/api_validation_result_items.md
- About:
- Conservation International: about/ci.md
- Kartoza: about/kartoza.md
- License: about/license.md
plugins:
- search
- git-revision-date-localized
- mkdocs-video
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://mkdocstrings.github.io/autorefs/objects.inv
options:
docstring_style: sphinx
separate_signature: true
merge_init_into_class: true
docstring_options:
ignore_init_summary: true
theme:
name: material
logo: about/img/cplus_logo_white_background.svg
features:
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.indexes
- navigation.instant
- navigation.tabs.sticky
- navigation.tracking
- toc.integrate
- toc.follow
- navigation.top
- search.suggest
- search.highlight
- search.share
- content.tabs.link
- content.code.annotation
- content.code.copy
- header.autohide
language: en
palette:
- scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Dark mode
primary: green
accent: purple
- scheme: slate
toggle:
icon: material/toggle-switch
name: Light mode
primary: teal
accent: lime
extra:
social:
- icon: fontawesome/brands/github-alt
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- def_list
- admonition
- pymdownx.arithmatex:
generic: true
- footnotes
- pymdownx.details
- pymdownx.superfences
- pymdownx.mark
- attr_list
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js