Add docstring to facilitate doc generation for dockerize subcommand #1136
Conversation
ishaileshpant
force-pushed
the
add-docstring-dockerize
branch
from
3272c5d
to
d403581
Compare
ishaileshpant
force-pushed
the
add-docstring-dockerize
branch
from
d403581
to
b361d83
Compare
…ize` command - Rebased - 11/Nov/2024 Signed-off-by: Shailesh Pant <[email protected]>
ishaileshpant
force-pushed
the
add-docstring-dockerize
branch
from
b361d83
to
5ae659d
Compare
ishaileshpant
changed the title
| Parameters: | ||
| context: The context object that provides access to shared information and methods,such as invoking other commands or accessing configuration settings. | ||
| save (bool): If True, saves the workspace Docker image as a tarball (`.tar`) file. | ||
| rebuild (bool): If True, forces a rebuild of the Docker images without using the cache. | ||
| revision (str): Specifies the OpenFL revision to use as a build argument in the Docker build process. | ||
|
|
||
| Returns: | ||
| None | ||
|
|
||
| Raises: | ||
| RuntimeError: If any of the Docker commands fail during execution. |
There was a problem hiding this comment.
This portion isn't required, click generates argument-specific docstrings from the options decorators.
| To package the workspace and save the Docker image as a tarball: | ||
|
|
||
| ```python | ||
| dockerize_(context, save=True, rebuild=False, revision='main') |
There was a problem hiding this comment.
Users won't be calling the python functions, so I suggest providing command examples.
|
@ishaileshpant With #1140 merged, this readme provides (incomplete) details on how to use dockerize subcommand. I am open to ideas on how (and where) to best document practices on how to run an enclave-enabled container. |
May be first thing is to fix this readme or link a doc specifically detailing enclave based run possibly here https://github.com/securefederatedai/openfl/tree/develop/docs/developer_guide/advanced_topics - wdyt @MasterSkepticista ? |
No description provided.