Open generated documentation

From the project root or one of its subdirectories, run docinsight open to open existing generated output:

shell
docinsight open

The command opens output from the selected target without running another build.

Select an output target

open requires exactly one selected output target. If the default selection contains more than one target, pass the target name:

shell
docinsight open --target site

If the target was built with an output path override, pass the same override to open it:

shell
docinsight open --target site=Z:/docs/mylibrary

Open HTML output

How DocInsight opens an HTML target depends on its URL settings:

  • With the default HTML page URLs and relative links, DocInsight opens the generated entry page directly from the local file system.

  • With clean page URLs or root-relative links, DocInsight starts a local HTTP server, opens the site in your browser, and keeps serving until you press Ctrl+C.

The local server supports the configured URL behavior; it does not rebuild or live-update the documentation.

Open CHM output

For a CHM target, DocInsight opens the generated .chm file.

If the output is missing or stale, build the documentation first.

Open after building

Use build --open to build and open one target in a single command:

shell
docinsight build --target site --open