Automated Documentation generation capabilities

Learn about the automated Documentation generation capabilities in IBM® Bob Premium Package for Z.

Using the Documentation generation feature you can do the following:

Generate documentation in multiple languages, such as Japanese, French, Spanish, and so on.
Resume documentation generation from the last checkpoint if the generation process fails or aborts.
Remove the existing Documentation folder created by a previous documentation generation run automatically, eliminating the need for manual deletion.

Generating documentation in multiple languages

To generate documentation in any of the following languages: Japanese, French, Spanish, German, Portuguese, Korean, and Dutch, complete the following steps:

Open the Linux Terminal window.
Navigate to the installation directory using the following command:
```
cd /<installation directory>
```
Type the following command to generate documentation in a specific language. For example, run the following command to generate documentation in Japanese:
```
./cli.sh -doc -language ja -api-key <api key> <PROJECT_NAME>
```
Once the documentation generation is complete, the documentation folder is created under installation directory/projects/<PROJECT_NAME>/Documentation.
Language specified program documents are located under the /programs_<language> folder, named <program_name>_<language>.md.

Resuming documentation generation from checkpoint

To resume generating documentation from a checkpoint, complete the following steps:

Open the Linux Terminal window.
Navigate to the installation directory using the following command:
```
cd /<installation directory>
```
Type the command to resume generating the documentation. For example, run the following command to resume documentation in Japanese:
```
./cli.sh -doc -resume -api-key <api key> <PROJECT_NAME> 
```
Note: When resuming from a checkpoint, modifications to config.yaml or language options are disregarded, as the system loads all configurations from the checkpoint.
A log message is created at the start of resumed generation indicating that the checkpoint has been validated for configs and the generated program documents. For example,
```
INFO     Checkpoint config is validated.
INFO     Resuming documentation generation from checkpoint...                                     
WARNING  Configuration settings are loaded from checkpoint. Any modifications to config.yaml will be ignored. 
```
```
INFO     Checkpoint <program_name_1>.prog_state.json validated.
```
```
INFO     Checkpoint <program_name_2>.prog_state.json validated.
```
A documentation folder is created under installation directory/projects/<PROJECT_NAME>/Documentation.

Removing the existing Documentation folder

To remove the Documentation folder created by a previous documentation generation run, complete the following steps:

Open the Linux Terminal window.
Navigate to the installation directory using the following command:
```
cd /<installation directory>
```
Check if the /Documentation folder exists in the following directory:
```
ls <installation directory>/projects/<PROJECT_NAME>/Documentation
```
Type the following command to delete the documentation folder:
```
./cli.sh -doc -delete <PROJECT_NAME> 
```
The /Documentation folder is deleted under: <installation directory>/projects/<PROJECT_NAME>.
A log message is created as follows:
```
INFO     Delete existing documentation at <installation directory>/projects/<PROJECT_NAME>/Documentation
```