Skip to content

Commit fe69377

Browse files
dtedte
authored
fix: update docs to include workflows (#343)
1 parent dee1a25 commit fe69377

36 files changed

+13507
-3841
lines changed

‎docs/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: b7f16c84dedf5c89b7d44098de0a545b
3+
config: 5349479d681a2ec8a6923e1d2529be6f
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_sources/gradient.api_sdk.clients.rst.txt

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,30 @@ gradient.api\_sdk.clients.clusters module
2020
:undoc-members:
2121
:show-inheritance:
2222

23+
gradient.api\_sdk.clients.dataset\_client module
24+
------------------------------------------------
25+
26+
.. automodule:: gradient.api_sdk.clients.dataset_client
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
gradient.api\_sdk.clients.dataset\_tag\_client module
32+
-----------------------------------------------------
33+
34+
.. automodule:: gradient.api_sdk.clients.dataset_tag_client
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
gradient.api\_sdk.clients.dataset\_version\_client module
40+
---------------------------------------------------------
41+
42+
.. automodule:: gradient.api_sdk.clients.dataset_version_client
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
2347
gradient.api\_sdk.clients.deployment\_client module
2448
---------------------------------------------------
2549

@@ -116,6 +140,14 @@ gradient.api\_sdk.clients.secret\_client module
116140
:undoc-members:
117141
:show-inheritance:
118142

143+
gradient.api\_sdk.clients.storage\_provider\_client module
144+
----------------------------------------------------------
145+
146+
.. automodule:: gradient.api_sdk.clients.storage_provider_client
147+
:members:
148+
:undoc-members:
149+
:show-inheritance:
150+
119151
gradient.api\_sdk.clients.tensorboards\_client module
120152
-----------------------------------------------------
121153

@@ -124,6 +156,14 @@ gradient.api\_sdk.clients.tensorboards\_client module
124156
:undoc-members:
125157
:show-inheritance:
126158

159+
gradient.api\_sdk.clients.workflow\_client module
160+
-------------------------------------------------
161+
162+
.. automodule:: gradient.api_sdk.clients.workflow_client
163+
:members:
164+
:undoc-members:
165+
:show-inheritance:
166+
127167
Module contents
128168
---------------
129169

‎docs/_sources/gradient.api_sdk.models.rst.txt

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,22 @@ gradient.api\_sdk.models.dataset module
2828
:undoc-members:
2929
:show-inheritance:
3030

31+
gradient.api\_sdk.models.dataset\_tag module
32+
--------------------------------------------
33+
34+
.. automodule:: gradient.api_sdk.models.dataset_tag
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
gradient.api\_sdk.models.dataset\_version module
40+
------------------------------------------------
41+
42+
.. automodule:: gradient.api_sdk.models.dataset_version
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
3147
gradient.api\_sdk.models.deployment module
3248
------------------------------------------
3349

@@ -44,6 +60,14 @@ gradient.api\_sdk.models.experiment module
4460
:undoc-members:
4561
:show-inheritance:
4662

63+
gradient.api\_sdk.models.experiment\_dataset module
64+
---------------------------------------------------
65+
66+
.. automodule:: gradient.api_sdk.models.experiment_dataset
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
4771
gradient.api\_sdk.models.hyperparameter module
4872
----------------------------------------------
4973

@@ -92,6 +116,14 @@ gradient.api\_sdk.models.notebook module
92116
:undoc-members:
93117
:show-inheritance:
94118

119+
gradient.api\_sdk.models.pagination module
120+
------------------------------------------
121+
122+
.. automodule:: gradient.api_sdk.models.pagination
123+
:members:
124+
:undoc-members:
125+
:show-inheritance:
126+
95127
gradient.api\_sdk.models.project module
96128
---------------------------------------
97129

@@ -108,6 +140,14 @@ gradient.api\_sdk.models.secret module
108140
:undoc-members:
109141
:show-inheritance:
110142

143+
gradient.api\_sdk.models.storage\_provider module
144+
-------------------------------------------------
145+
146+
.. automodule:: gradient.api_sdk.models.storage_provider
147+
:members:
148+
:undoc-members:
149+
:show-inheritance:
150+
111151
gradient.api\_sdk.models.tag module
112152
-----------------------------------
113153

@@ -132,6 +172,14 @@ gradient.api\_sdk.models.vm\_type module
132172
:undoc-members:
133173
:show-inheritance:
134174

175+
gradient.api\_sdk.models.workflows module
176+
-----------------------------------------
177+
178+
.. automodule:: gradient.api_sdk.models.workflows
179+
:members:
180+
:undoc-members:
181+
:show-inheritance:
182+
135183
Module contents
136184
---------------
137185

‎docs/_sources/gradient.api_sdk.repositories.rst.txt

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,30 @@ gradient.api\_sdk.repositories.common module
2020
:undoc-members:
2121
:show-inheritance:
2222

23+
gradient.api\_sdk.repositories.dataset\_tags module
24+
---------------------------------------------------
25+
26+
.. automodule:: gradient.api_sdk.repositories.dataset_tags
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
gradient.api\_sdk.repositories.dataset\_versions module
32+
-------------------------------------------------------
33+
34+
.. automodule:: gradient.api_sdk.repositories.dataset_versions
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
gradient.api\_sdk.repositories.datasets module
40+
----------------------------------------------
41+
42+
.. automodule:: gradient.api_sdk.repositories.datasets
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
2347
gradient.api\_sdk.repositories.deployments module
2448
-------------------------------------------------
2549

@@ -100,6 +124,14 @@ gradient.api\_sdk.repositories.secrets module
100124
:undoc-members:
101125
:show-inheritance:
102126

127+
gradient.api\_sdk.repositories.storage\_providers module
128+
--------------------------------------------------------
129+
130+
.. automodule:: gradient.api_sdk.repositories.storage_providers
131+
:members:
132+
:undoc-members:
133+
:show-inheritance:
134+
103135
gradient.api\_sdk.repositories.tags module
104136
------------------------------------------
105137

@@ -116,6 +148,14 @@ gradient.api\_sdk.repositories.tensorboards module
116148
:undoc-members:
117149
:show-inheritance:
118150

151+
gradient.api\_sdk.repositories.workflows module
152+
-----------------------------------------------
153+
154+
.. automodule:: gradient.api_sdk.repositories.workflows
155+
:members:
156+
:undoc-members:
157+
:show-inheritance:
158+
119159
Module contents
120160
---------------
121161

‎docs/_sources/gradient.api_sdk.serializers.rst.txt

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,22 @@ gradient.api\_sdk.serializers.dataset module
3636
:undoc-members:
3737
:show-inheritance:
3838

39+
gradient.api\_sdk.serializers.dataset\_tag module
40+
-------------------------------------------------
41+
42+
.. automodule:: gradient.api_sdk.serializers.dataset_tag
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
gradient.api\_sdk.serializers.dataset\_version module
48+
-----------------------------------------------------
49+
50+
.. automodule:: gradient.api_sdk.serializers.dataset_version
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
3955
gradient.api\_sdk.serializers.deployment module
4056
-----------------------------------------------
4157

@@ -52,6 +68,14 @@ gradient.api\_sdk.serializers.experiment module
5268
:undoc-members:
5369
:show-inheritance:
5470

71+
gradient.api\_sdk.serializers.experiment\_dataset module
72+
--------------------------------------------------------
73+
74+
.. automodule:: gradient.api_sdk.serializers.experiment_dataset
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
5579
gradient.api\_sdk.serializers.hyperparameter module
5680
---------------------------------------------------
5781

@@ -116,6 +140,14 @@ gradient.api\_sdk.serializers.secret module
116140
:undoc-members:
117141
:show-inheritance:
118142

143+
gradient.api\_sdk.serializers.storage\_provider module
144+
------------------------------------------------------
145+
146+
.. automodule:: gradient.api_sdk.serializers.storage_provider
147+
:members:
148+
:undoc-members:
149+
:show-inheritance:
150+
119151
gradient.api\_sdk.serializers.tag module
120152
----------------------------------------
121153

@@ -148,6 +180,14 @@ gradient.api\_sdk.serializers.vm\_type module
148180
:undoc-members:
149181
:show-inheritance:
150182

183+
gradient.api\_sdk.serializers.workflows module
184+
----------------------------------------------
185+
186+
.. automodule:: gradient.api_sdk.serializers.workflows
187+
:members:
188+
:undoc-members:
189+
:show-inheritance:
190+
151191
Module contents
152192
---------------
153193

‎docs/_sources/gradient.commands.rst.txt

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ gradient.commands.common module
2020
:undoc-members:
2121
:show-inheritance:
2222

23+
gradient.commands.datasets module
24+
---------------------------------
25+
26+
.. automodule:: gradient.commands.datasets
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
2331
gradient.commands.deployments module
2432
------------------------------------
2533

@@ -108,6 +116,14 @@ gradient.commands.secrets module
108116
:undoc-members:
109117
:show-inheritance:
110118

119+
gradient.commands.storage\_providers module
120+
-------------------------------------------
121+
122+
.. automodule:: gradient.commands.storage_providers
123+
:members:
124+
:undoc-members:
125+
:show-inheritance:
126+
111127
gradient.commands.tensorboards module
112128
-------------------------------------
113129

@@ -116,6 +132,14 @@ gradient.commands.tensorboards module
116132
:undoc-members:
117133
:show-inheritance:
118134

135+
gradient.commands.workflows module
136+
----------------------------------
137+
138+
.. automodule:: gradient.commands.workflows
139+
:members:
140+
:undoc-members:
141+
:show-inheritance:
142+
119143
Module contents
120144
---------------
121145

‎docs/_static/basic.css

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx stylesheet -- basic theme.
66
*
7-
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -764,6 +764,7 @@ div.code-block-caption code {
764764
}
765765

766766
table.highlighttable td.linenos,
767+
span.linenos,
767768
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
768769
user-select: none;
769770
}

‎docs/_static/doctools.js

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx JavaScript utilities for all documentation.
66
*
7-
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -29,9 +29,14 @@ if (!window.console || !console.firebug) {
2929

3030
/**
3131
* small helper function to urldecode strings
32+
*
33+
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
3234
*/
3335
jQuery.urldecode = function(x) {
34-
return decodeURIComponent(x).replace(/\+/g, ' ');
36+
if (!x) {
37+
return x
38+
}
39+
return decodeURIComponent(x.replace(/\+/g, ' '));
3540
};
3641

3742
/**
@@ -285,9 +290,10 @@ var Documentation = {
285290
initOnKeyListeners: function() {
286291
$(document).keydown(function(event) {
287292
var activeElementType = document.activeElement.tagName;
288-
// don't navigate when in search box or textarea
293+
// don't navigate when in search box, textarea, dropdown or button
289294
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
290-
&& !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
295+
&& activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
296+
&& !event.shiftKey) {
291297
switch (event.keyCode) {
292298
case 37: // left
293299
var prevHref = $('link[rel="prev"]').prop('href');

0 commit comments

Comments
 (0)