Generate Docs API

[ScottCarda-MS]

Adds a new module to the qsc for docs generation and moves the display module from the language server to this new module. The docs generation is used by the npm to build library API docs from the doc comments of our Q# library code and puts those docs in the npm package. This is done when the npm package is built.

[github-actions]

Benchmark for d725833

Click to view benchmark

Test	Base	PR	%
Array append evaluation	760.4±6.38µs	762.0±8.61µs	+0.21%
Array literal evaluation	504.4±11.36µs	536.6±48.28µs	+6.38%
Array update evaluation	838.4±6.50µs	839.8±6.19µs	+0.17%
Deutsch-Jozsa evaluation	30.5±0.24ms	30.5±0.41ms	0.00%
Large file parity evaluation	35.3±0.13ms	35.4±0.50ms	+0.28%
Large input file	43.7±1.20ms	43.9±1.34ms	+0.46%
Standard library	24.7±0.97ms	25.5±0.96ms	+3.24%
Teleport evaluation	97.1±2.82µs	97.6±2.53µs	+0.51%

[github-actions]

Benchmark for c50c0c8

Click to view benchmark

Test	Base	PR	%
Array append evaluation	770.4±3.49µs	762.5±10.14µs	-1.03%
Array literal evaluation	513.8±25.33µs	548.4±64.59µs	+6.73%
Array update evaluation	849.6±5.58µs	840.6±13.29µs	-1.06%
Deutsch-Jozsa evaluation	30.7±1.04ms	30.4±0.18ms	-0.98%
Large file parity evaluation	35.2±0.12ms	35.2±0.26ms	0.00%
Large input file	40.1±0.85ms	39.8±0.98ms	-0.75%
Standard library	22.7±0.53ms	22.7±0.51ms	0.00%
Teleport evaluation	99.4±1.88µs	97.6±1.84µs	-1.81%

[github-actions]

Benchmark for ba68c60

Click to view benchmark

Test	Base	PR	%
Array append evaluation	762.5±14.96µs	759.1±3.35µs	-0.45%
Array literal evaluation	514.5±21.99µs	513.4±29.07µs	-0.21%
Array update evaluation	853.0±5.88µs	842.1±13.74µs	-1.28%
Deutsch-Jozsa evaluation	30.4±0.25ms	30.4±0.21ms	0.00%
Large file parity evaluation	35.4±0.11ms	35.3±0.11ms	-0.28%
Large input file	43.1±1.92ms	42.0±1.10ms	-2.55%
Standard library	24.3±0.69ms	24.0±0.70ms	-1.23%
Teleport evaluation	97.7±1.95µs	98.4±1.74µs	+0.72%

[github-actions]

Benchmark for d65c3fb

Click to view benchmark

Test	Base	PR	%
Array append evaluation	775.4±19.99µs	761.1±7.84µs	-1.84%
Array literal evaluation	515.8±5.23µs	512.2±31.85µs	-0.70%
Array update evaluation	848.7±7.80µs	840.5±8.10µs	-0.97%
Deutsch-Jozsa evaluation	30.3±0.21ms	30.5±0.49ms	+0.66%
Large file parity evaluation	35.2±0.04ms	35.2±0.05ms	0.00%
Large input file	39.7±0.74ms	39.6±1.01ms	-0.25%
Standard library	22.9±0.48ms	23.1±0.48ms	+0.87%
Teleport evaluation	97.5±1.51µs	97.9±3.61µs	+0.41%

[github-actions]

Benchmark for 5adf25e

Click to view benchmark

Test	Base	PR	%
Array append evaluation	749.3±8.46µs	751.7±4.89µs	+0.32%
Array literal evaluation	519.5±21.00µs	534.9±21.03µs	+2.96%
Array update evaluation	827.5±7.27µs	824.0±10.87µs	-0.42%
Deutsch-Jozsa evaluation	30.4±0.20ms	30.3±0.26ms	-0.33%
Large file parity evaluation	35.2±0.23ms	35.0±0.11ms	-0.57%
Large input file	41.1±0.85ms	41.7±1.60ms	+1.46%
Standard library	23.7±0.53ms	23.5±0.69ms	-0.84%
Teleport evaluation	96.5±1.85µs	94.3±1.96µs	-2.28%

[github-actions]

Benchmark for 916c457

Click to view benchmark

Test	Base	PR	%
Array append evaluation	749.2±6.51µs	753.7±6.78µs	+0.60%
Array literal evaluation	539.9±38.59µs	527.2±15.75µs	-2.35%
Array update evaluation	821.6±4.45µs	828.5±8.81µs	+0.84%
Deutsch-Jozsa evaluation	30.2±0.17ms	30.2±0.41ms	0.00%
Large file parity evaluation	35.1±0.09ms	35.3±0.65ms	+0.57%
Large input file	42.7±1.39ms	42.3±1.43ms	-0.94%
Standard library	25.2±1.04ms	24.1±0.80ms	-4.37%
Teleport evaluation	95.5±1.70µs	95.8±1.81µs	+0.31%

[github-actions]

Benchmark for 961d5b7

Click to view benchmark

Test	Base	PR	%
Array append evaluation	752.9±21.80µs	753.5±12.58µs	+0.08%
Array literal evaluation	542.2±13.15µs	564.0±56.53µs	+4.02%
Array update evaluation	822.9±10.12µs	830.4±36.44µs	+0.91%
Deutsch-Jozsa evaluation	30.3±0.21ms	30.2±0.18ms	-0.33%
Large file parity evaluation	35.2±0.13ms	35.4±0.47ms	+0.57%
Large input file	41.1±1.94ms	41.0±1.54ms	-0.24%
Standard library	23.7±0.85ms	23.8±0.77ms	+0.42%
Teleport evaluation	95.7±1.82µs	96.5±2.11µs	+0.84%

[github-actions]

Benchmark for 96ee19a

Click to view benchmark

Test	Base	PR	%
Array append evaluation	755.2±8.41µs	756.2±13.07µs	+0.13%
Array literal evaluation	512.4±11.52µs	526.6±28.72µs	+2.77%
Array update evaluation	827.6±18.28µs	828.8±6.90µs	+0.14%
Deutsch-Jozsa evaluation	30.2±0.24ms	30.3±0.82ms	+0.33%
Large file parity evaluation	35.2±0.32ms	35.2±0.12ms	0.00%
Large input file	41.8±1.54ms	40.4±0.87ms	-3.35%
Standard library	23.8±0.51ms	23.3±0.58ms	-2.10%
Teleport evaluation	95.2±1.73µs	96.4±1.76µs	+1.26%

[minestarks]

Signing off on the language service-adjacent parts, didn't get a chance to look at the actual doc generation utility.

[sezna]

Nice, moving timestamping to npm is definitely a win.

[github-actions]

Benchmark for 4a395d3

Click to view benchmark

Test	Base	PR	%
Array append evaluation	753.1±8.86µs	754.9±5.93µs	+0.24%
Array literal evaluation	511.7±18.48µs	527.8±30.08µs	+3.15%
Array update evaluation	824.0±4.18µs	828.6±4.53µs	+0.56%
Deutsch-Jozsa evaluation	30.2±0.22ms	30.3±0.22ms	+0.33%
Large file parity evaluation	35.2±0.18ms	35.3±0.23ms	+0.28%
Large input file	40.5±0.85ms	40.6±1.43ms	+0.25%
Standard library	23.1±0.52ms	23.3±0.62ms	+0.87%
Teleport evaluation	96.0±1.62µs	97.3±1.52µs	+1.35%

[github-actions]

Benchmark for 52a8bfa

Click to view benchmark

Test	Base	PR	%
Array append evaluation	747.9±6.94µs	767.1±4.58µs	+2.57%
Array literal evaluation	544.5±18.79µs	527.5±32.44µs	-3.12%
Array update evaluation	820.0±16.30µs	838.9±8.40µs	+2.30%
Deutsch-Jozsa evaluation	30.2±0.20ms	30.4±0.23ms	+0.66%
Large file parity evaluation	35.0±0.07ms	35.3±0.14ms	+0.86%
Large input file	40.3±0.90ms	40.2±1.02ms	-0.25%
Standard library	23.4±1.15ms	22.9±0.49ms	-2.14%
Teleport evaluation	96.5±3.13µs	98.8±1.42µs	+2.38%

[github-actions]

Benchmark for 48b005d

Click to view benchmark

Test	Base	PR	%
Array append evaluation	754.7±12.87µs	750.7±5.64µs	-0.53%
Array literal evaluation	518.0±9.15µs	560.8±42.78µs	+8.26%
Array update evaluation	825.3±4.22µs	818.5±3.88µs	-0.82%
Deutsch-Jozsa evaluation	30.4±1.31ms	30.3±0.28ms	-0.33%
Large file parity evaluation	35.1±0.09ms	35.3±0.17ms	+0.57%
Large input file	41.3±0.88ms	42.2±1.22ms	+2.18%
Standard library	24.6±0.50ms	23.5±0.49ms	-4.47%
Teleport evaluation	96.1±2.12µs	97.6±2.10µs	+1.56%