Exporting documentation to HTML

Applies to: Dataedo 23.x (current) versions, Article available also for: 10.x

Dataedo enables exporting your documentation to an interactive HTML site. To export the documentation select chosen documentation in the navigation tree and click Export documentation button in the ribbon.

Export button

It opens Export documentation wizard. The first step is to choose a format. Choose 'HTML' and click Next.

Export documentation

Choose the default Single Page Application template, or customize it. If you're seeing different template list, we recommend upgrading to current version of Dataedo.

After selecting the template, click Next.

Select Template

Now you may choose modules you want to exclude from your documentation, just uncheck them. 'Other' module means all unassigned objects. By default, all modules are selected.

Choose modules

Now you may define which elements you want in your documentation.

Choose object types

Select custom and data classification fields to export.

Choose custom fields

In last step, you can choose a destination folder and file name. Click Export to start.

Choose file

Your document is being generated:

Generating documentation

When ready you will be asked if you want to open a browser.

Open file

Your export is complete.

Learn more:

  1. Publishing on web server
  2. Publishing documentation on Confluence
Found issue with this article? Comment below
Comments are only visible when the visitor has consented to statistics cookies. To see and add comments please accept statistics cookies.
0
There are no comments. Click here to write the first comment.