-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
122 lines (118 loc) · 4.28 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
site_name: Pygen Docs
docs_dir: docs
use_directory_urls: false
theme:
name: material
logo: logo/logo.svg
favicon: logo/logo.svg
features:
- content.code.copy
- content.tooltips
nav:
- Home: index.md
- What is Pygen?: what_is_pygen.md
- Quickstart:
- Where to Start: quickstart/where_to_start.md
- Exploration CDF Notebook: quickstart/cdf_notebook.ipynb
- Exploration Local Notebook: quickstart/notebook.ipynb
- Building Solution: quickstart/project.md
- Building Solution CDF Streamlit: quickstart/cdf_streamlit.md
- Data Population (Ingestion): quickstart/ingestion.ipynb
- Data Migration: quickstart/migration.ipynb
- Installation: installation.md
- CLI: cli.md
- Usage:
- Generation of SDK: usage/generation.ipynb
- Listing, filtering, and retrieving: usage/listing_filtering_retrieving.ipynb
- Searching: usage/searching.ipynb
- Aggregation: usage/aggregation.ipynb
- Selecting: usage/querying.ipynb
- Creating and Deleting: usage/creating_deleting.ipynb
- Working with Time Series: usage/timeseries.ipynb
- Working with Files: usage/files.ipynb
- Working with Edges: usage/edge_properties.ipynb
- Cognite Functions: cognite_functions.md
- Extra:
- Generating Mock Data: extra/mock_data.ipynb
- (Experimental) Generic query: extra/generic_query.ipynb
- Example SDK Docs:
- Home: example_docs/index.md
- CogniteCore Client: example_docs/core_client.md
- CogniteCore APIs: example_docs/core_apis.md
- CogniteCore Data Classes: example_docs/core_data_classes.md
- Omni Client: example_docs/omni_client.md
- Omni APIs: example_docs/omni_apis.md
- Omni Data Classes: example_docs/omni_data_classes.md
- WindTurbine Client: example_docs/wind_client.md
- WindTurbine APIs: example_docs/wind_apis.md
- WindTurbine Data Classes: example_docs/wind_data_classes.md
- Developer Docs:
- Querying: docs-dev/docs_query.ipynb
- Filters: docs-dev/query_filter.ipynb
- Reference - Code API:
- Pygen: api/api.md
- Demo: api/demo.md
- Exceptions: api/exceptions.md
- Utilities:
- Main: api/utils.md
- CDF: api/utils_cdf.md
- Mock Generator: api/utils_mock_generator.md
- Text: api/utils_text.md
- ExternalID Factories: api/utils_external_id_factory.md
- Pygen Config:
- Home: config/index.md
- Naming: config/naming.md
- Filtering: config/filtering_methods.md
- Changelog: https://github.com/cognitedata/pygen/releases
- Contributor Docs:
- Home: developer_docs/index.md
- Core:
- Generators: developer_docs/core/generators.md
- Templates: developer_docs/core/templates.md
- Models:
- APIClasses: developer_docs/core/models/api_classes.md
- DataClasses: developer_docs/core/models/data_classes.md
- Fields:
- Base: developer_docs/core/models/fields/base.md
- Primitive: developer_docs/core/models/fields/primitive.md
- CDF Reference: developer_docs/core/models/fields/cdf_reference.md
- Connections: developer_docs/core/models/fields/connections.md
- FilterMethods: developer_docs/core/models/filter_methods.md
- Validation: developer_docs/core/validation.md
markdown_extensions:
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- tables
- abbr
- attr_list
- admonition
- pymdownx.details
- pymdownx.superfences
plugins:
- mkdocs-jupyter:
execute: false
ignore_h1_titles: True
include_source: True
remove_tag_config:
remove_input_tags:
- hide
- glightbox:
width: 100%
height: auto
- mkdocstrings:
default_handler: python
handlers:
python:
options:
show_root_heading: true
show_source: true
- search
exclude_docs: |
.*