Generate database documentation

After you create a database documentation project, you can generate documentation in HTML, PDF, and Markdown formats.

To generate documentation:

1. On the documentation project toolbar, click Generate.

2. In the Generate Documentation dialog, select the output format and destination:

• HTML and Markdown:

  1. In Save in, specify the folder to save the documentation, or click the ellipsis (…) and select the folder.

  2. In Folder name, enter the name of the folder for the generated documentation.

• PDF:

  1. In Save in, specify the folder to save the documentation, or click the ellipsis (…) and select the folder.

  2. In File name, enter the file name.

Note

The documentation in the HTML and Markdown file formats is generated as a set of files in the folder. The default path is C:\Users\<user_name>\Documents.

The documentation in the PDF file format is generated as a single file and saved to the specified folder. For more information, see View documentation.

3. To remove the date and time from the output name, clear the Append timestamp checkbox:

• For PDF, this removes the timestamp from the file name.
• For HTML and Markdown, this removes the timestamp from the folder name.

4. To prevent the documentation from opening after generation, clear the Open documentation after generation checkbox.

Note

Append timestamp to the file name and Open documentation after generation are selected by default.

5. (For the PDF format) Click Options and set up the page settings:

• Paper Size – Select the paper size.
• Orientation – Select a portrait or landscape page orientation.
• Font Scale – Use and to decrease or increase the font size. The default value is 100%.
• Page Numbers – Turn on the toggle to show page numbers. By default, it is turned off.

Click OK.

6. Click Generate.

Note

To save the documentation generation settings to a .bat file to use it for recurring command-line tasks, click Save Command Line.