Skip to content

Commit 05699c8

Browse files
committed
Improve API documentation
1 parent 1399d52 commit 05699c8

5 files changed

Lines changed: 34 additions & 27 deletions

File tree

docs/metafold.rst

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,50 +4,52 @@ metafold package
44
Submodules
55
----------
66

7-
metafold.api module
8-
-------------------
7+
Module contents
8+
---------------
99

10-
.. automodule:: metafold.api
10+
.. automodule:: metafold
11+
:members:
12+
:show-inheritance:
13+
14+
metafold.projects module
15+
------------------------
16+
17+
.. automodule:: metafold.projects
1118
:members:
12-
:undoc-members:
1319
:show-inheritance:
1420

1521
metafold.assets module
1622
----------------------
1723

1824
.. automodule:: metafold.assets
1925
:members:
20-
:undoc-members:
2126
:show-inheritance:
2227

23-
metafold.client module
24-
----------------------
28+
metafold.jobs module
29+
--------------------
2530

26-
.. automodule:: metafold.client
31+
.. automodule:: metafold.jobs
2732
:members:
28-
:undoc-members:
2933
:show-inheritance:
3034

31-
metafold.exceptions module
32-
--------------------------
35+
metafold.client module
36+
----------------------
3337

34-
.. automodule:: metafold.exceptions
38+
.. automodule:: metafold.client
3539
:members:
36-
:undoc-members:
3740
:show-inheritance:
3841

39-
metafold.jobs module
42+
metafold.func module
4043
--------------------
4144

42-
.. automodule:: metafold.jobs
45+
.. automodule:: metafold.func
4346
:members:
4447
:undoc-members:
4548
:show-inheritance:
4649

47-
Module contents
48-
---------------
50+
metafold.exceptions module
51+
--------------------------
4952

50-
.. automodule:: metafold
53+
.. automodule:: metafold.exceptions
5154
:members:
52-
:undoc-members:
5355
:show-inheritance:

metafold/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ class MetafoldClient(Client):
1313
assets: Sub-client for assets endpoint.
1414
jobs: Sub-client for jobs endpoint.
1515
"""
16+
projects: ProjectsEndpoint
17+
assets: AssetsEndpoint
18+
jobs: JobsEndpoint
1619

1720
def __init__(
1821
self, access_token: str,

metafold/func.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# ruff: noqa: F401
2-
"""
3-
This file was automatically generated from the source file: func.py.in.
4-
Any edits should be made to the template file before re-running the codegen.
5-
"""
2+
# This file was automatically generated from the source file: func.py.in.
3+
# Any edits should be made to the template file before re-running the codegen.
64
from typing import Literal, Optional, TypedDict, TypeVar, TYPE_CHECKING, Union
75
from typing import cast
86
import sys

metafold/func.py.in

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# ruff: noqa: F401
2-
"""
3-
This file was automatically generated from the source file: func.py.in.
4-
Any edits should be made to the template file before re-running the codegen.
5-
"""
2+
# This file was automatically generated from the source file: func.py.in.
3+
# Any edits should be made to the template file before re-running the codegen.
64
from typing import Literal, Optional, TypedDict, TypeVar, TYPE_CHECKING, Union
75
from typing import cast
86
import sys

metafold/projects.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@
99

1010

1111
class Access(Enum):
12+
"""Project access scope.
13+
14+
Attributes:
15+
PRIVATE: Project is private to owner.
16+
PUBLIC: Project may be accessed by unauthenticated users.
17+
"""
1218
PRIVATE = "private"
1319
PUBLIC = "public"
1420

0 commit comments

Comments
 (0)