Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
epwalsh committed Apr 11, 2022
1 parent fdf66c7 commit 5f3eb09
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 1 deletion.
2 changes: 1 addition & 1 deletion beaker/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
Nodes
-----
Manage Beaker nodes.
Manage Beaker nodes with :data:`Beaker.node`.
For example, you can get information about a node with
:meth:`Beaker.node.get() <services.NodeClient.get>`:
Expand Down
48 changes: 48 additions & 0 deletions beaker/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,59 +94,107 @@ def config(self) -> Config:
def account(self) -> AccountClient:
"""
Manage accounts.
.. tip::
See the `Accounts Overview <overview.html#accounts>`_ for a walk-through of the
main methods, or check out the `Account API Docs <#account>`_
to see all of the available methods.
"""
return self._account

@property
def organization(self) -> OrganizationClient:
"""
Manage organizations.
.. tip::
See the `Organizations Overview <overview.html#organizations>`_ for a walk-through of the
main methods, or check out the `Organization API Docs <#organization>`_
to see all of the available methods.
"""
return self._organization

@property
def workspace(self) -> WorkspaceClient:
"""
Manage workspaces.
.. tip::
See the `Workspaces Overview <overview.html#workspaces>`_ for a walk-through of the
main methods, or check out the `Workspace API Docs <#workspace>`_
to see all of the available methods.
"""
return self._workspace

@property
def cluster(self) -> ClusterClient:
"""
Manage clusters.
.. tip::
See the `Clusters Overview <overview.html#clusters>`_ for a walk-through of the
main methods, or check out the `Cluster API Docs <#cluster>`_
to see all of the available methods.
"""
return self._cluster

@property
def node(self) -> NodeClient:
"""
Manage nodes.
.. tip::
See the `Nodes Overview <overview.html#nodes>`_ for a walk-through of the
main methods, or check out the `Node API Docs <#node>`_
to see all of the available methods.
"""
return self._node

@property
def dataset(self) -> DatasetClient:
"""
Manage datasets.
.. tip::
See the `Datasets Overview <overview.html#datasets>`_ for a walk-through of the
main methods, or check out the `Dataset API Docs <#dataset>`_
to see all of the available methods.
"""
return self._dataset

@property
def image(self) -> ImageClient:
"""
Manage images.
.. tip::
See the `Images Overview <overview.html#images>`_ for a walk-through of the
main methods, or check out the `Image API Docs <#image>`_
to see all of the available methods.
"""
return self._image

@property
def job(self) -> JobClient:
"""
Manage jobs.
.. tip::
See the `Jobs Overview <overview.html#jobs>`_ for a walk-through of the
main methods, or check out the `Job API Docs <#job>`_
to see all of the available methods.
"""
return self._job

@property
def experiment(self) -> ExperimentClient:
"""
Manage experiments.
.. tip::
See the `Experiments Overview <overview.html#experiments>`_ for a walk-through of the
main methods, or check out the `Experiment API Docs <#experiment>`_
to see all of the available methods.
"""
return self._experiment

Expand Down

0 comments on commit 5f3eb09

Please sign in to comment.