Skip to content

Commit 25fd9be

Browse files
[Automated Commit] Format Codebase [skip ci]
1 parent 5527a14 commit 25fd9be

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

automation/script/doc.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,18 +53,23 @@ def generate_doc(self_module, input_params):
5353
script_input_mapping = metadata.get('input_mapping', {})
5454
script_input_description = metadata.get('input_description', {})
5555
script_repo = script.repo
56-
r = generate_docs(script_repo, metadata, script_directory, generic_inputs)
56+
r = generate_docs(
57+
script_repo,
58+
metadata,
59+
script_directory,
60+
generic_inputs)
5761
if r['return'] > 0:
5862
continue
5963

6064
return {'return': 0}
6165

66+
6267
def get_setup_readme(script_repo):
6368
repo_alias = os.path.basename(script_repo.meta.get('alias'))
6469
repo_name = repo_alias
6570
if '@' in repo_name:
6671
repo_name = repo_name.split('@')[1]
67-
72+
6873
setup_readme = f"""`mlcflow` stores all local data under `$HOME/MLC` by default. So, if there is space constraint on the home directory and you have more space on say `/mnt/user`, you can do
6974
```
7075
mkdir /mnt/user/MLC
@@ -97,6 +102,7 @@ def get_setup_readme(script_repo):
97102
"""
98103
return {'return': 0, 'setup_readme': setup_readme}
99104

105+
100106
def generate_docs(script_repo, metadata, script_path, generic_inputs):
101107
script_name = metadata.get('alias', metadata['uid'])
102108
info_doc_exists = os.path.exists(os.path.join(script_path, 'info.md'))
@@ -110,13 +116,13 @@ def generate_docs(script_repo, metadata, script_path, generic_inputs):
110116
{readme_prefix}
111117
"""
112118

113-
r = get_setup_readme(script_repo)
119+
r = get_setup_readme(script_repo)
114120
if r['return'] > 0:
115121
return r
116122

117123
setup_readme = r['setup_readme']
118124
doc_content += setup_readme
119-
125+
120126
readme_dir = script_path
121127

122128
if not os.path.exists(readme_dir):

0 commit comments

Comments
 (0)