DocBuilder Class

Definition

Namespace:

Microsoft.Quantum.QsCompiler.Documentation

Assembly:

Microsoft.Quantum.QsDocumentationParser.dll

Package:

Microsoft.Quantum.Compiler v0.25.218240

Caution

The YAML-based documentation builder has been replaced by the Markdown-based DocumentationGenerator.

This class contains the functionality for writing all of the documentation YAML files for an entire compilation.

[System.Obsolete("The YAML-based documentation builder has been replaced by the Markdown-based DocumentationGenerator.")]
public class DocBuilder

[<System.Obsolete("The YAML-based documentation builder has been replaced by the Markdown-based DocumentationGenerator.")>]
type DocBuilder = class

Public Class DocBuilder

Inheritance

Object

DocBuilder

Attributes

ObsoleteAttribute

Constructors

DocBuilder(String, IEnumerable<QsNamespace>, IEnumerable<String>)

Constructs a new documentation builder instance.

Methods

BuildDocs()	Generates all of the documentation files for a build. This includes the top-level table of contents (toc.yml), a table of contents for each namespace, and a detailed file for each callable and type. If the root directory does not exist, it will be created and populated.
Run(String, IEnumerable<QsNamespace>, IEnumerable<String>, Action<Exception>)	Generates all of the documentation files for a build. Returns true if no exception occurred during generation, and false otherwise.