11# Documentation Generation Guide
22
3- This guide explains how to generate documentation for Onlyoffice Builder and
4- Plugins (Methods/Events) API using the following Python scripts:
3+ This guide explains how to generate documentation for Onlyoffice Builder
4+ and Plugins (Methods/Events) API using the following Python scripts:
55
66- ` office-api/generate_docs_json.py `
77- ` office-api/generate_docs_md.py `
@@ -38,8 +38,8 @@ This script generates JSON documentation based on the `apiBuilder.js` files.
3838 ```
3939
4040- ** Parameters** :
41- - ` output_path ` (optional): The directory where the JSON documentation will be
42- saved. If not specified, the default path is
41+ - ` output_path ` (optional): The directory where the JSON documentation
42+ will be saved. If not specified, the default path is
4343 ` ../../../../office-js-api-declarations/office-js-api ` .
4444
4545### ` office-api/generate_docs_md.py `
@@ -53,8 +53,8 @@ This script generates Markdown documentation from the `apiBuilder.js` files.
5353 ```
5454
5555- ** Parameters** :
56- - ` output_path ` (optional): The directory where the Markdown documentation will
57- be saved. If not specified, the default path is
56+ - ` output_path ` (optional): The directory where the Markdown documentation
57+ will be saved. If not specified, the default path is
5858 ` ../../../../office-js-api/ ` .
5959
6060### ` plugins/generate_docs_methods_json.py `
@@ -68,8 +68,8 @@ This script generates JSON documentation based on the `api_plugins.js` files.
6868 ```
6969
7070- ** Parameters** :
71- - ` output_path ` (optional): The directory where the JSON documentation will be
72- saved. If not specified, the default path is
71+ - ` output_path ` (optional): The directory where the JSON documentation
72+ will be saved. If not specified, the default path is
7373 ` ../../../../office-js-api-declarations/office-js-api-plugins ` .
7474
7575### ` plugins/generate_docs_events_json.py `
@@ -83,8 +83,8 @@ This script generates JSON documentation based on the `plugin-events.js` files.
8383 ```
8484
8585- ** Parameters** :
86- - ` output_path ` (optional): The directory where the JSON documentation will be
87- saved. If not specified, the default path is
86+ - ` output_path ` (optional): The directory where the JSON documentation
87+ will be saved. If not specified, the default path is
8888 ` ../../../../office-js-api-declarations/office-js-api-plugins ` .
8989
9090### ` plugins/generate_docs_methods_md.py `
@@ -98,8 +98,8 @@ This script generates Markdown documentation from the `api_plugins.js` files.
9898 ```
9999
100100- ** Parameters** :
101- - ` output_path ` (optional): The directory where the Markdown documentation will
102- be saved. If not specified, the default path is
101+ - ` output_path ` (optional): The directory where the Markdown documentation
102+ will be saved. If not specified, the default path is
103103 ` ../../../../office-js-api/ ` .
104104
105105### ` plugins/generate_docs_events_md.py `
@@ -113,8 +113,8 @@ This script generates Markdown documentation from the `plugin-events.js` files.
113113 ```
114114
115115- ** Parameters** :
116- - ` output_path ` (optional): The directory where the Markdown documentation will
117- be saved. If not specified, the default path is
116+ - ` output_path ` (optional): The directory where the Markdown documentation
117+ will be saved. If not specified, the default path is
118118 ` ../../../../office-js-api/ ` .
119119
120120## Example
@@ -133,6 +133,6 @@ python generate_docs_md.py /path/to/save/markdown
133133
134134## Notes
135135
136- - Make sure to have all necessary permissions to run these scripts and write to
137- the specified directories.
136+ - Make sure to have all necessary permissions to run these scripts and write
137+ to the specified directories.
138138- The output directories will be created if they do not exist.
0 commit comments