pengjunjie/build_tools
1
0
Fork 1
mirror of https://github.com/ONLYOFFICE/build_tools.git synced 2026-02-10 20:45:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fixed jsdoc md generation

Browse Source
This commit is contained in:
Nikita Khromov
2024-08-02 21:26:44 +07:00
parent 0983e67f21
commit 6736f84d54
2 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
scripts/sdkjs_common/jsdoc/generate_docs_json.py
View File

@ -19,7 +19,7 @@ editors_maps = {
"forms": "CFE"
}
def generate(output_dir):
def generate(output_dir, md=False):
missing_examples_file = f'{output_dir}/missing_examples.txt'
if not os.path.exists(output_dir):
@ -51,9 +51,12 @@ def generate(output_dir):
if 'see' in doclet:
if doclet['see'] is not None:
if editor_name == 'forms':
file_path = '../../../../' + doclet['see'][0].replace('{Editor}', 'Word')
doclet['see'][0] = doclet['see'][0].replace('{Editor}', 'Word')
else:
file_path = '../../../../' + doclet['see'][0].replace('{Editor}', editor_name.title())
doclet['see'][0] = doclet['see'][0].replace('{Editor}', editor_name.title())
file_path = '../../../../' + doclet['see'][0]
if os.path.exists(file_path):
with open(file_path, 'r', encoding='utf-8') as see_file:
example_content = see_file.read()
@ -68,7 +71,11 @@ def generate(output_dir):
code_content = example_content
# Format content for doclet['example']
doclet['example'] = remove_js_comments(comment) + "```js\n" + remove_builder_lines(code_content) + "\n```"
doclet['example'] = remove_js_comments(comment) + "```js\n" + code_content + "\n```"
if md == False:
doclet['description'] = doclet['description'] + f'\n\n## Try it\n\n ```js document-builder={{"documentType": "{editor_name.title()}"}}\n{code_content}\n```'
else:
# Record missing examples in missing_examples.txt
with open(missing_examples_file, 'a', encoding='utf-8') as missing_file:

2
scripts/sdkjs_common/jsdoc/generate_docs_md.py
View File

@ -241,7 +241,7 @@ def process_doclets(data, output_dir):
def generate(output_dir):
print('Generating Markdown documentation...')
generate_docs_json.generate(output_dir + 'tmp_json')
generate_docs_json.generate(output_dir + 'tmp_json', md=True)
for editor_name in editors:
input_file = os.path.join(output_dir + 'tmp_json', editor_name + ".json")
os.makedirs(output_dir + f'/{editor_name.title()}', exist_ok=True)