Skip to content

Commit 393a5c1

Browse files
committed
fix link fmt, typos and restructure front/landing page
1 parent 3343521 commit 393a5c1

2 files changed

Lines changed: 31 additions & 2 deletions

File tree

MIGRATION_GUIDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Changes are grouped as follows:
6363
- For `class Transformation`, which used to have an async `run` method, this is now named `run_async` to unify the overall interface. The same applies to the `cancel` and `jobs` methods for the same class, and `update` and `wait` on `TransformationJob`.
6464
- **ClientConfig**:
6565
- `max_workers` has functionally been removed (just throws a warning). Concurrency is now controlled via `global_config.concurrency_settings`.
66-
See the `Settings documentation <https://cognite-sdk-python.readthedocs-hosted.com/en/v8/settings.html#concurrency-settings>`_ for details.
66+
See the [Settings documentation](https://cognite-sdk-python.readthedocs-hosted.com/en/v8/settings.html#concurrency-settings) for details.
6767
- `timeout`: default has been increased from 30 sec to 60 sec
6868
- **global_config**:
6969
- New setting `follow_redirects` that controls whether or not to follow redirects. Defaults to `False`.
@@ -106,7 +106,7 @@ Changes are grouped as follows:
106106
- **Synthetic datapoints queries**: Now return `SyntheticDatapoints` or `SyntheticDatapointsList` instead of `Datapoints` or `DatapointsList`. The `error` field only exists on `SyntheticDatapoints` (where it belongs). Use `to_pandas(include_errors=True)` on `SyntheticDatapoints` to include the error column.
107107
- **Datapoint subscriptions**: `DatapointsUpdate.upserts` is now `SubscriptionDatapoints` instead of `Datapoints`.
108108
- `Datapoints` class no longer has the `error` attribute (moved to `SyntheticDatapoints`).
109-
- `Datapoints` and `DatapointsArray` now require `id` and `is_step, `is_string` and `type`.
109+
- `Datapoints` and `DatapointsArray` now require `id` and `is_step`, `is_string` and `type`.
110110
- Removed `include_errors` parameter from `Datapoints.to_pandas()`. This parameter only applies to `SyntheticDatapoints.to_pandas()`.
111111
- Iterating through a `DatapointsArray` is no longer supported. Access the numpy arrays directly and use vectorised operations instead.
112112
- Extending a `Datapoints` instance is no longer supported.

docs/source/index.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,24 @@ See the :doc:`quickstart` for configuration examples.
9090

9191
Contents
9292
^^^^^^^^
93+
94+
Getting Started
95+
"""""""""""""""
9396
.. toctree::
97+
:maxdepth: 2
98+
9499
quickstart
95100
settings
96101
credential_providers
97102
cognite_client
98103
extensions_and_optional_dependencies
99104
identity_and_access_management
105+
106+
Core Resources
107+
""""""""""""""
108+
.. toctree::
109+
:maxdepth: 1
110+
100111
data_modeling
101112
agents
102113
ai
@@ -107,18 +118,36 @@ Contents
107118
time_series
108119
sequences
109120
3d
121+
122+
Data Processing
123+
"""""""""""""""
124+
.. toctree::
125+
:maxdepth: 1
126+
110127
contextualization
111128
data_ingestion
112129
transformations
113130
functions
114131
data_workflows
132+
133+
Specialized Features
134+
""""""""""""""""""""
135+
.. toctree::
136+
:maxdepth: 1
137+
115138
simulators
116139
geospatial
117140
unit_catalog
118141
hosted_extractors
119142
postgres_gateway
120143
data_organization
121144
limits
145+
146+
Reference
147+
"""""""""
148+
.. toctree::
149+
:maxdepth: 1
150+
122151
filters
123152
deprecated
124153
exceptions

0 commit comments

Comments
 (0)