Skip to content

Commit 83315dd

Browse files
committed
Fix docs missing DetectorPlatformClient class
In #131, we turned APIClient into an alias for DetectorPlatformClient, but that broke the docs since calling :members: on APIClient wouldn't display any functions So this adds both APIClient and DetectorPlatformClient to the API docs
1 parent d8721c8 commit 83315dd

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

docs/api.rst

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,31 @@ API
33
===
44

55

6-
DetectorPlatformClient
7-
----------------------
6+
Detector Platform
7+
-----------------
88

9-
.. autoclass:: picterra.APIClient
9+
.. autoclass:: picterra.DetectorPlatformClient
1010
:members:
1111

12+
.. autoclass:: picterra.APIClient
13+
:members:
1214

13-
PlotsAnalysisPlatformClient
14-
---------------------------
15-
16-
.. autoclass:: picterra.PlotsAnalysisPlatformClient
15+
.. automodule:: picterra.nongeo
1716
:members:
1817

1918

20-
Pagination
21-
----------
19+
Plots Analysis Platform
20+
-----------------------
2221

23-
.. autoclass:: picterra.ResultsPage
22+
.. autoclass:: picterra.PlotsAnalysisPlatformClient
2423
:members:
2524

2625

27-
nongeo
28-
------
26+
Utility classes
27+
---------------
2928

30-
.. automodule:: picterra.nongeo
29+
.. autoclass:: picterra.ResultsPage
3130
:members:
3231

33-
34-
Exceptions
35-
----------
36-
3732
.. autoclass:: picterra.APIError
3833
:members:

0 commit comments

Comments
 (0)