Skip to content

Commit 51b9831

Browse files
committed
resolve doc errors
1 parent 6fbfe3b commit 51b9831

6 files changed

Lines changed: 72 additions & 18 deletions

File tree

docs/source/UserGuides/Edge/Files.rst

Lines changed: 51 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22
File Browser
33
============
44

5+
Synchronous API
6+
===============
57

68
List
7-
====
9+
----
810

911
.. automethod:: cterasdk.edge.files.browser.FileBrowser.listdir
1012
:noindex:
@@ -15,7 +17,7 @@ List
1517
print(item.name, item.fullpath)
1618
1719
Download
18-
========
20+
--------
1921

2022
.. automethod:: cterasdk.edge.files.browser.FileBrowser.download
2123
:noindex:
@@ -32,7 +34,7 @@ Download
3234
edge.files.download_many('network-share/docs', ['Sample.docx', 'Summary.xlsx'])
3335
3436
Create Directory
35-
================
37+
----------------
3638

3739
.. automethod:: cterasdk.edge.files.browser.FileBrowser.mkdir
3840
:noindex:
@@ -51,7 +53,7 @@ Create Directory
5153
5254
5355
Copy
54-
====
56+
----
5557

5658
.. automethod:: cterasdk.edge.files.browser.FileBrowser.copy
5759
:noindex:
@@ -69,7 +71,7 @@ Copy
6971
7072
7173
Move
72-
====
74+
----
7375

7476
.. automethod:: cterasdk.edge.files.browser.FileBrowser.move
7577
:noindex:
@@ -86,11 +88,54 @@ Move
8688
edge.files.move('cloud/users/Bruce Wayne/My Files/Summary.xlsx', destination='cloud/users/Bruce Wayne/Spreadsheets', overwrite=True)
8789
8890
Delete
89-
======
91+
------
9092

9193
.. automethod:: cterasdk.edge.files.browser.FileBrowser.delete
9294
:noindex:
9395

9496
.. code:: python
9597
9698
edge.files.delete('cloud/users/Service Account/My Files/Documents')
99+
100+
101+
Asynchronous API
102+
================
103+
104+
Asynchronous API
105+
================
106+
107+
.. automethod:: cterasdk.asynchronous.edge.files.browser.FileBrowser.handle
108+
:noindex:
109+
110+
.. automethod:: cterasdk.asynchronous.edge.files.browser.FileBrowser.handle_many
111+
:noindex:
112+
113+
.. automethod:: cterasdk.asynchronous.edge.files.browser.FileBrowser.download
114+
:noindex:
115+
116+
.. automethod:: cterasdk.asynchronous.edge.files.browser.FileBrowser.download_many
117+
:noindex:
118+
119+
.. automethod:: cterasdk.asynchronous.edge.files.browser.FileBrowser.listdir
120+
:noindex:
121+
122+
.. automethod:: cterasdk.asynchronous.edge.files.browser.FileBrowser.copy
123+
:noindex:
124+
125+
.. automethod:: cterasdk.asynchronous.edge.files.browser.FileBrowser.move
126+
:noindex:
127+
128+
.. automethod:: cterasdk.asynchronous.edge.files.browser.CloudDrive.upload
129+
:noindex:
130+
131+
.. automethod:: cterasdk.asynchronous.edge.files.browser.CloudDrive.upload_file
132+
:noindex:
133+
134+
.. automethod:: cterasdk.asynchronous.edge.files.browser.CloudDrive.mkdir
135+
:noindex:
136+
137+
.. automethod:: cterasdk.asynchronous.edge.files.browser.CloudDrive.makedirs
138+
:noindex:
139+
140+
.. automethod:: cterasdk.asynchronous.edge.files.browser.CloudDrive.delete
141+
:noindex:
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
cterasdk.clients.tracers.logger module
2-
======================================
1+
cterasdk.clients.tracers.requests module
2+
========================================
33

4-
.. automodule:: cterasdk.clients.tracers.logger
4+
.. automodule:: cterasdk.clients.tracers.requests
55
:members:
66
:undoc-members:
77
:show-inheritance:

docs/source/api/cterasdk.clients.tracers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ Submodules
1111

1212
.. toctree::
1313

14-
cterasdk.clients.tracers.logger
1514
cterasdk.clients.tracers.postman
15+
cterasdk.clients.tracers.requests
1616
cterasdk.clients.tracers.session

docs/source/api/cterasdk.lib.filesystem.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/source/api/cterasdk.lib.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ Submodules
1313

1414
cterasdk.lib.cmd
1515
cterasdk.lib.consent
16-
cterasdk.lib.filesystem
1716
cterasdk.lib.iterator
1817
cterasdk.lib.platform
1918
cterasdk.lib.registry
19+
cterasdk.lib.storage
2020
cterasdk.lib.tempfile
2121
cterasdk.lib.tracker
2222
cterasdk.lib.version
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
cterasdk.lib.storage package
2+
============================
3+
4+
.. automodule:: cterasdk.lib.storage
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
.. toctree::
13+
14+
cterasdk.lib.storage.asynfs
15+
cterasdk.lib.storage.commonfs
16+
cterasdk.lib.storage.synfs

0 commit comments

Comments
 (0)