lv-doc-tools 2.2.0

Tool for generating documentation of LabView projects.

lv_doc_tools

Tools for streamlining doucmentation of LabView projects

This module provides a wrapper for the antidoc, ascii-doctor and caraya test tools. It is aimed at simple CLI interface and incorporation to CD pipelines. The configuration is via a single json file.

Note

This project has been set up using PyScaffold 4.6. For details and usage information on PyScaffold see https://pyscaffold.org/.

Installation

Depending on your platform, you may need to install additional dependencies for asciidoctor:

• Windows: Install asciidoctor-pdf using the following command:

  pip install lv_doc_tools

Alternatively, you can install asciidoctor manually on Windowss by following these steps or using the link(https://docs.asciidoctor.org/asciidoctor/latest/install/windows/): 1. Install Ruby from the official website: https://rubyinstaller.org/downloads/ 2. Verify that Ruby is installed correctly by running ruby -v in the command prompt. 3. Install the Asciidoctor gem by running the following command in the command prompt:

gem install asciidoctor-pdf

Usage

Once installed, you can use the CLI tool lv_doc_tool to generate documentation. For example:

lv_doc_tool config.json

This will read the config.json file and generate the documentation based on the configuration.

Help

To see the available options for the CLI tool, run:

lv_doc_tool --help