The LabVIEW tool

You can use Antidoc directly from the LabVIEW interface.

To open the tool, select Tools  Antidoc  Generate Documentation… in the LabVIEW menu.

Main interface

The tool’s user interface appears once the installed add-ons have been fully loaded.

Antidoc main user interface
Figure 1. Main user interface

You can select the add-on you want to use via the drop-down menu at the top left corner.

Add-on drop down menu used to select the add-on to use
Figure 2. Add-on selector

The user interface will be updated according to the add-on selection.

If you don’t have any add-ons installed, a message will be displayed to invite you to install at least one of them through VIPM and the tool will stop executing.

To generate the document, you have to click on the Generate documentation button.

Document generation progress bar
Figure 3. Document generation

General settings

You can configure the behavior of the tool through the settings window.

The settings window button
Figure 4. The settings button
The general settings window
Figure 5. The general settings window

This window offers different settings:

Documentation format to generate

Allows you to select which files are generated at the end of the process. If no option is selected, you’ll only get adoc files and images.

Documentation file name

Allows you to redefine the name of the document generated. If the option is disabled, the name of the document is defined by the add-on.

Documentation destination

Allows you to redefine the disk location where the generated document is stored. If the option is disabled, the location is defined by the add-on.

Advanced generation settings
Use AsciiDoctor custom installation

If enabled, you need to point to a folder where the Asciidoctor toolchain is installed.

Disable SSL verification for diagram generation

This option can be enabled to prevent errors when generating documents that contain diagrams

Use custom diagram image generation

Allow you to define a different way to generate diagrams

Custom Kroki server

By default diagrams are generated connecting https://kroki.io/. You can define another Kroki server here.

Local renderer

If the option is generated, Asciidoctor will use local tools not installed by default to generate the diagrams.

Open document after generation

Enable this option to open the generated document with the default application associated at the end of the process.

Clean up destination folder

Enable this option to remove all the intermediate files generated during the process.

Advanced configuration

You can configure advanced Antidoc behavior using an INI file named Antidoc.ini stored in ..\Documents\LabVIEW Data\Antidoc.

This file is not mandatory to get Antidoc to work. By default, this file doesn’t exist.
Antidoc.ini file content
[Antidoc]
AdditionalAddonsSearchPath="C:\Users\team\Documents\open-source-projects"(1)
AdditionalAddonsSearchPathLvVersion=14.0.1f11(2)
ContentNotFoundPlaceholder="Another placeholder text"(3)

[Custom Attributes](4)
toclevels=4
sectnuùmslevels=4
stylesheet=MyCustomStylesheet.css
1 Additional path where Antidoc is looking for add-ons. Use this parameter if you develop your add-on and want to debug it without building a package.
2 Limit the search for additional add-ons to a specific LabVIEW version.
3 Set a custom string to display in the documentation generated when content is not found in the LabVIEW code
4 In this section, each key represents an AsciiDoc attribute. That’s the way for you to customize the output (the PDF or the HTML) you can get at the end of the documentation generation process.
For more information about AsciiDoctor attributes see the Asciidoctor documention