build_tools/scripts/sdkjs_common/jsdoc

Documentation Generation Guide

This guide explains how to generate documentation for Onlyoffice Builder and Plugins (Methods/Events) API using the following Python scripts:

• office-api/generate_docs_json.py
• office-api/generate_docs_md.py
• plugins/generate_docs_methods_json.py
• plugins/generate_docs_methods_md.py
• plugins/generate_docs_events_json.py
• plugins/generate_docs_events_md.py

Requirements

Node.js v20 and above
Python v3.10 and above

Installation

git clone https://github.com/ONLYOFFICE/build_tools.git
cd build_tools/scripts/sdkjs_common/jsdoc
npm install

Scripts Overview

office-api/generate_docs_json.py

This script generates JSON documentation based on the apiBuilder.js files.

• Usage:

  python generate_docs_json.py output_path
  

• Parameters:

  • output_path (optional): The directory where the JSON documentation will be saved. If not specified, the default path is ../../../../office-js-api-declarations/office-js-api.

office-api/generate_docs_md.py

This script generates Markdown documentation from the apiBuilder.js files.

• Usage:

  python generate_docs_md.py output_path
  

• Parameters:

  • output_path (optional): The directory where the Markdown documentation will be saved. If not specified, the default path is ../../../../office-js-api/.

plugins/generate_docs_methods_json.py

This script generates JSON documentation based on the api_plugins.js files.

• Usage:

  python generate_docs_methods_json.py output_path
  

• Parameters:

  • output_path (optional): The directory where the JSON documentation will be saved. If not specified, the default path is ../../../../office-js-api-declarations/office-js-api-plugins.

plugins/generate_docs_events_json.py

This script generates JSON documentation based on the plugin-events.js files.

• Usage:

  python generate_docs_events_json.py output_path
  

• Parameters:

  • output_path (optional): The directory where the JSON documentation will be saved. If not specified, the default path is ../../../../office-js-api-declarations/office-js-api-plugins.

plugins/generate_docs_methods_md.py

This script generates Markdown documentation from the api_plugins.js files.

• Usage:

  python generate_docs_methods_md.py output_path
  

• Parameters:

  • output_path (optional): The directory where the Markdown documentation will be saved. If not specified, the default path is ../../../../office-js-api/.

plugins/generate_docs_events_md.py

This script generates Markdown documentation from the plugin-events.js files.

• Usage:

  python generate_docs_events_md.py output_path
  

• Parameters:

  • output_path (optional): The directory where the Markdown documentation will be saved. If not specified, the default path is ../../../../office-js-api/.

Example

To generate JSON documentation with the default output path:

python generate_docs_json.py /path/to/save/json

To generate Markdown documentation and specify a custom output path:

python generate_docs_md.py /path/to/save/markdown

Notes

• Make sure to have all necessary permissions to run these scripts and write to the specified directories.
• The output directories will be created if they do not exist.