Skip to content

Commit 9ffab8c

Browse files
haakonvthaakonvt
authored
docs: greatly improve sidebar sectioning and expand Data Modeling (DM-3846) (#2667)
1 parent 5be58e2 commit 9ffab8c

11 files changed

Lines changed: 167 additions & 166 deletions

File tree

‎docs/source/data_modeling/containers.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Containers
2+
==========
3+
4+
.. currentmodule:: cognite.client
5+
6+
.. autosummary::
7+
:methods:
8+
:toctree: ../generated/
9+
:template: custom-automethods-template.rst
10+
11+
AsyncCogniteClient.data_modeling.containers
12+
13+
Containers data classes
14+
^^^^^^^^^^^^^^^^^^^^^^^^
15+
.. automodule:: cognite.client.data_classes.data_modeling.containers
16+
:members:
17+
:show-inheritance:

‎docs/source/data_modeling/core_data_model.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Core Data Model
2+
===============
3+
4+
.. automodule:: cognite.client.data_classes.data_modeling.cdm.v1
5+
:members:
6+
:show-inheritance:

‎docs/source/data_modeling/data_models.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Data Models
2+
===========
3+
4+
.. currentmodule:: cognite.client
5+
6+
.. autosummary::
7+
:methods:
8+
:toctree: ../generated/
9+
:template: custom-automethods-template.rst
10+
11+
AsyncCogniteClient.data_modeling.data_models
12+
13+
Data model data classes
14+
^^^^^^^^^^^^^^^^^^^^^^^^
15+
.. automodule:: cognite.client.data_classes.data_modeling.data_models
16+
:members:
17+
:show-inheritance:

‎docs/source/data_modeling/graphql.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
GraphQL
2+
=======
3+
4+
.. currentmodule:: cognite.client
5+
6+
.. autosummary::
7+
:methods:
8+
:toctree: ../generated/
9+
:template: custom-automethods-template.rst
10+
11+
AsyncCogniteClient.data_modeling.graphql
12+
13+
GraphQL data classes
14+
^^^^^^^^^^^^^^^^^^^^
15+
.. automodule:: cognite.client.data_classes.data_modeling.graphql
16+
:members:
17+
:show-inheritance:

docs/source/data_modeling.rst renamed to docs/source/data_modeling/instances.rst

Lines changed: 3 additions & 154 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,11 @@
1-
Data Modeling
2-
=============
3-
4-
.. currentmodule:: cognite.client
5-
6-
Data Models
7-
------------
8-
.. autosummary::
9-
:methods:
10-
:toctree: generated/
11-
:template: custom-automethods-template.rst
12-
13-
AsyncCogniteClient.data_modeling.data_models
14-
15-
Data model data classes
16-
^^^^^^^^^^^^^^^^^^^^^^^^
17-
.. automodule:: cognite.client.data_classes.data_modeling.data_models
18-
:members:
19-
:show-inheritance:
20-
21-
.. currentmodule:: cognite.client
22-
23-
Spaces
24-
------
25-
.. autosummary::
26-
:methods:
27-
:toctree: generated/
28-
:template: custom-automethods-template.rst
29-
30-
AsyncCogniteClient.data_modeling.spaces
31-
32-
Data classes
33-
^^^^^^^^^^^^
34-
.. automodule:: cognite.client.data_classes.data_modeling.spaces
35-
:members:
36-
:show-inheritance:
37-
38-
.. currentmodule:: cognite.client
39-
40-
Views
41-
------------
42-
.. autosummary::
43-
:methods:
44-
:toctree: generated/
45-
:template: custom-automethods-template.rst
46-
47-
AsyncCogniteClient.data_modeling.views
48-
49-
View data classes
50-
^^^^^^^^^^^^^^^^^^^^^^^^
51-
.. automodule:: cognite.client.data_classes.data_modeling.views
52-
:members:
53-
:show-inheritance:
54-
55-
.. currentmodule:: cognite.client
56-
57-
Containers
58-
------------
59-
.. autosummary::
60-
:methods:
61-
:toctree: generated/
62-
:template: custom-automethods-template.rst
63-
64-
AsyncCogniteClient.data_modeling.containers
65-
66-
Containers data classes
67-
^^^^^^^^^^^^^^^^^^^^^^^^
68-
.. automodule:: cognite.client.data_classes.data_modeling.containers
69-
:members:
70-
:show-inheritance:
1+
Instances
2+
=========
713

724
.. currentmodule:: cognite.client
735

74-
Instances
75-
------------
766
.. autosummary::
777
:methods:
78-
:toctree: generated/
8+
:toctree: ../generated/
799
:template: custom-automethods-template.rst
8010

8111
AsyncCogniteClient.data_modeling.instances
@@ -265,84 +195,3 @@ Data Modeling ID data classes
265195
.. automodule:: cognite.client.data_classes.data_modeling.ids
266196
:members:
267197
:show-inheritance:
268-
269-
.. currentmodule:: cognite.client
270-
271-
Statistics
272-
------------
273-
.. autosummary::
274-
:methods:
275-
:toctree: generated/
276-
:template: custom-automethods-template.rst
277-
278-
AsyncCogniteClient.data_modeling.statistics
279-
AsyncCogniteClient.data_modeling.statistics.spaces
280-
281-
Data modeling statistics data classes
282-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
283-
.. automodule:: cognite.client.data_classes.data_modeling.statistics
284-
:members:
285-
:show-inheritance:
286-
287-
.. currentmodule:: cognite.client
288-
289-
Streams
290-
-------
291-
.. autosummary::
292-
:methods:
293-
:toctree: generated/
294-
:template: custom-automethods-template.rst
295-
296-
AsyncCogniteClient.data_modeling.streams
297-
298-
Streams data classes
299-
^^^^^^^^^^^^^^^^^^^^
300-
.. automodule:: cognite.client.data_classes.data_modeling.streams
301-
:members:
302-
:show-inheritance:
303-
304-
.. currentmodule:: cognite.client
305-
306-
GraphQL
307-
-------
308-
.. autosummary::
309-
:methods:
310-
:toctree: generated/
311-
:template: custom-automethods-template.rst
312-
313-
AsyncCogniteClient.data_modeling.graphql
314-
315-
Core Data Model
316-
---------------
317-
.. automodule:: cognite.client.data_classes.data_modeling.cdm.v1
318-
:members:
319-
:show-inheritance:
320-
321-
Extractor Extensions
322-
--------------------
323-
.. automodule:: cognite.client.data_classes.data_modeling.extractor_extensions.v1
324-
:members:
325-
:show-inheritance:
326-
327-
Debugging Data Classes
328-
----------------------
329-
.. automodule:: cognite.client.data_classes.data_modeling.debug
330-
:members:
331-
:show-inheritance:
332-
333-
.. currentmodule:: cognite.client
334-
335-
Records
336-
-------
337-
.. autosummary::
338-
:methods:
339-
:toctree: generated/
340-
:template: custom-automethods-template.rst
341-
342-
AsyncCogniteClient.data_modeling.records
343-
344-
Records data classes
345-
^^^^^^^^^^^^^^^^^^^^^
346-
.. automodule:: cognite.client.data_classes.data_modeling.records
347-
:members:
348-
:show-inheritance:

‎docs/source/data_modeling/records.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Records
2+
=======
3+
4+
.. currentmodule:: cognite.client
5+
6+
.. autosummary::
7+
:methods:
8+
:toctree: ../generated/
9+
:template: custom-automethods-template.rst
10+
11+
AsyncCogniteClient.data_modeling.records
12+
13+
Records data classes
14+
^^^^^^^^^^^^^^^^^^^^^
15+
.. automodule:: cognite.client.data_classes.data_modeling.records
16+
:members:
17+
:show-inheritance:

‎docs/source/data_modeling/spaces.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Spaces
2+
======
3+
4+
.. currentmodule:: cognite.client
5+
6+
.. autosummary::
7+
:methods:
8+
:toctree: ../generated/
9+
:template: custom-automethods-template.rst
10+
11+
AsyncCogniteClient.data_modeling.spaces
12+
13+
Data classes
14+
^^^^^^^^^^^^
15+
.. automodule:: cognite.client.data_classes.data_modeling.spaces
16+
:members:
17+
:show-inheritance:

‎docs/source/data_modeling/statistics.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Statistics
2+
==========
3+
4+
.. currentmodule:: cognite.client
5+
6+
.. autosummary::
7+
:methods:
8+
:toctree: ../generated/
9+
:template: custom-automethods-template.rst
10+
11+
AsyncCogniteClient.data_modeling.statistics
12+
AsyncCogniteClient.data_modeling.statistics.spaces
13+
14+
Data modeling statistics data classes
15+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16+
.. automodule:: cognite.client.data_classes.data_modeling.statistics
17+
:members:
18+
:show-inheritance:

‎docs/source/data_modeling/streams.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Streams
2+
=======
3+
4+
.. currentmodule:: cognite.client
5+
6+
.. autosummary::
7+
:methods:
8+
:toctree: ../generated/
9+
:template: custom-automethods-template.rst
10+
11+
AsyncCogniteClient.data_modeling.streams
12+
13+
Streams data classes
14+
^^^^^^^^^^^^^^^^^^^^
15+
.. automodule:: cognite.client.data_classes.data_modeling.streams
16+
:members:
17+
:show-inheritance:

‎docs/source/data_modeling/views.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Views
2+
=====
3+
4+
.. currentmodule:: cognite.client
5+
6+
.. autosummary::
7+
:methods:
8+
:toctree: ../generated/
9+
:template: custom-automethods-template.rst
10+
11+
AsyncCogniteClient.data_modeling.views
12+
13+
View data classes
14+
^^^^^^^^^^^^^^^^^^^^^^^^
15+
.. automodule:: cognite.client.data_classes.data_modeling.views
16+
:members:
17+
:show-inheritance:

0 commit comments

Comments
 (0)