Add metadata needed for improved documentation generation

Chemistry/src/Jupyter/BroombridgeMagic.cs

@@ -16,7 +16,7 @@ public class BroombridgeMagic : MagicSymbol
         public BroombridgeMagic()
         {
             this.Name = $"%chemistry.broombridge";
-            this.Documentation = new Documentation() { Summary = "Loads and returns Broombridge electronic structure problem representation from a given .yaml file." };
+            this.Documentation = new Microsoft.Jupyter.Core.Documentation() { Summary = "Loads and returns Broombridge electronic structure problem representation from a given .yaml file." };
             this.Kind = SymbolKind.Magic;
             this.Execute = this.Run;
         }

Chemistry/src/Jupyter/ChemistryEncodeMagic.cs

@@ -17,7 +17,7 @@ public class ChemistryEncodeMagic : MagicSymbol
         public ChemistryEncodeMagic()
         {
             this.Name = $"%chemistry.encode";
-            this.Documentation = new Documentation() { Summary = "Encodes a fermion Hamiltonian to a format consumable by Q#." };
+            this.Documentation = new Microsoft.Jupyter.Core.Documentation() { Summary = "Encodes a fermion Hamiltonian to a format consumable by Q#." };
             this.Kind = SymbolKind.Magic;
             this.Execute = this.Run;
         }

Chemistry/src/Jupyter/FermionHamiltonianMagic.cs

@@ -26,7 +26,7 @@ public class FermionHamiltonianLoadMagic : MagicSymbol
         public FermionHamiltonianLoadMagic()
         {
             this.Name = $"%chemistry.fh.load";
-            this.Documentation = new Documentation() { Summary = "Loads the fermion Hamiltonian for an electronic structure problem. The problem is loaded from a file or passed as an argument." };
+            this.Documentation = new Microsoft.Jupyter.Core.Documentation() { Summary = "Loads the fermion Hamiltonian for an electronic structure problem. The problem is loaded from a file or passed as an argument." };
             this.Kind = SymbolKind.Magic;
             this.Execute = this.Run;
         }
@@ -113,7 +113,10 @@ public class FermionHamiltonianAddTermsMagic : MagicSymbol
         public FermionHamiltonianAddTermsMagic()
         {
             this.Name = $"%chemistry.fh.add_terms";
-            this.Documentation = new Documentation() { Summary = "Adds terms to a fermion Hamiltonian." };
+            this.Documentation = new Microsoft.Jupyter.Core.Documentation
+            {
+                Summary = "Adds terms to a fermion Hamiltonian."
+            };
             this.Kind = SymbolKind.Magic;
             this.Execute = this.Run;
         }

Chemistry/src/Jupyter/WavefunctionMagic.cs

@@ -20,7 +20,7 @@ public class WavefunctionMagic : MagicSymbol
         public WavefunctionMagic()
         {
             this.Name = $"%chemistry.inputstate.load";
-            this.Documentation = new Documentation() { Summary = "Loads Broombridge electronic structure problem and returns selected input state." };
+            this.Documentation = new Microsoft.Jupyter.Core.Documentation() { Summary = "Loads Broombridge electronic structure problem and returns selected input state." };
             this.Kind = SymbolKind.Magic;
             this.Execute = this.Run;
         }

Chemistry/src/Runtime/Runtime.csproj

@@ -6,6 +6,10 @@
     <QsharpDocsGeneration>true</QsharpDocsGeneration>
     <IncludeQsharpCorePackages>false</IncludeQsharpCorePackages>
     <RunQDocGen>True</RunQDocGen>
+    <!-- List the name of the metapackage that users can
+         use to take a dependency on these Q# APIs, rather
+         than the subpackage directly. -->
+    <QsharpDocsPackageId>Microsoft.Quantum.Chemistry</QsharpDocsPackageId>
   </PropertyGroup>
 
   <PropertyGroup>
@@ -44,4 +48,3 @@
   </ItemGroup>
 
 </Project>
-

MachineLearning/src/MachineLearning.csproj

@@ -3,6 +3,7 @@
     <TargetFramework>netstandard2.1</TargetFramework>
     <AssemblyName>Microsoft.Quantum.MachineLearning</AssemblyName>
     <QsharpDocsGeneration>true</QsharpDocsGeneration>
+    <QsharpDocsPackageId>Microsoft.Quantum.MachineLearning</QsharpDocsPackageId>
     <!--
       Include core packages using project references instead, since they get
       built at the same time as this project.

MachineLearning/src/Types.qs

@@ -10,7 +10,7 @@ namespace Microsoft.Quantum.MachineLearning {
     /// Describes a controlled rotation in terms of its target and control
     /// indices, rotation axis, and index into a model parameter vector.
     ///
-    /// # Input
+    /// # Named Items
     /// ## TargetIndex
     /// Index of the target qubit for this controlled rotation.
     /// ## ControlIndices
@@ -50,7 +50,7 @@ namespace Microsoft.Quantum.MachineLearning {
     /// parameterized and controlled rotations, an assignment of rotation
     /// angles, and a bias between the two classes recognized by the model.
     ///
-    /// # Input
+    /// # Named Items
     /// ## Structure
     /// The sequence of controlled rotations used to classify inputs.
     /// ## Parameters
@@ -70,7 +70,7 @@ namespace Microsoft.Quantum.MachineLearning {
     /// Describes an operation that prepares a given input to a sequential
     /// classifier.
     ///
-    /// # Input
+    /// # Named Items
     /// ## NQubits
     /// The number of qubits on which the encoded input is defined.
     /// ## Prepare
@@ -84,7 +84,7 @@ namespace Microsoft.Quantum.MachineLearning {
     /// # Summary
     /// A sample, labeled with a class to which that sample belongs.
     ///
-    /// # Input
+    /// # Named Items
     /// ## Features
     /// A vector of features for the given sample.
     /// ## Label
@@ -152,7 +152,7 @@ namespace Microsoft.Quantum.MachineLearning {
     /// The results from having validated a classifier against a set of
     /// samples.
     ///
-    /// # Input
+    /// # Named Items
     /// ## NMisclassifications
     /// The number of misclassifications observed during validation.
     newtype ValidationResults = (
@@ -163,7 +163,7 @@ namespace Microsoft.Quantum.MachineLearning {
     /// # Summary
     /// A collection of options to be used in training quantum classifiers.
     ///
-    /// # Input
+    /// # Named Items
     /// ## LearningRate
     /// The learning rate by which gradients should be rescaled when updating
     /// model parameters during training steps.

Numerics/src/Numerics.csproj

@@ -4,6 +4,7 @@
     <TargetFramework>netstandard2.1</TargetFramework>
     <AssemblyName>Microsoft.Quantum.Numerics</AssemblyName>
     <QsharpDocsGeneration>true</QsharpDocsGeneration>
+    <QsharpDocsPackageId>Microsoft.Quantum.Numerics</QsharpDocsPackageId>
     <IncludeQsharpCorePackages>false</IncludeQsharpCorePackages>
   </PropertyGroup>
 
@@ -45,4 +46,3 @@
   </ItemGroup>
 
 </Project>
-

Standard/src/AmplitudeAmplification/Types.qs

@@ -6,10 +6,15 @@ namespace Microsoft.Quantum.AmplitudeAmplification {
     /// # Summary
     /// Phases for a sequence of partial reflections in amplitude amplification.
     ///
-    /// # Remarks
-    /// The first parameter is an array of phases for reflection about the
-    /// start state. The second parameter is an array of phases for reflection
+    /// # Named Items
+    /// ## AboutStart
+    /// An array of phases for reflection about the
+    /// start state.
+    /// ## AboutTarget
+    /// An array of phases for reflection
     /// about the target state.
+    ///
+    /// # Remarks
     /// Both arrays must be of equal length. Note that in many cases, the first phase about the start state and last phase about the target state introduces a global phase shift and may be set to $0$.
     newtype ReflectionPhases = (
         AboutStart: Double[],

Standard/src/Math/Complex.qs

@@ -8,10 +8,10 @@ namespace Microsoft.Quantum.Math {
     ///
     /// The polar representation of a complex number is $c=r e^{i t}$.
     ///
-    /// # Input
-    /// ## First Parameter
+    /// # Named Items
+    /// ## Magnitude
     /// `Double` is absolute value $r \ge 0$.
-    /// ## Second Parameter
+    /// ## Argument
     /// `Double` is the phase $t \in \mathbb R$.
     newtype ComplexPolar = (Magnitude: Double, Argument: Double);
 

Standard/src/Math/Types.qs

@@ -4,6 +4,12 @@ namespace Microsoft.Quantum.Math {
     /// Represents a rational number of the form `p/q`. Integer `p` is
     /// the first element of the tuple and `q` is the second element
     /// of the tuple.
+    ///
+    /// # Named Items
+    /// ## Numerator
+    /// Numerator of the fraction.
+    /// ## Denominator
+    /// Denominator of the fraction/
     newtype Fraction = (
         Numerator: Int,
         Denominator: Int
@@ -13,6 +19,12 @@ namespace Microsoft.Quantum.Math {
     /// Represents a rational number of the form `p/q`. Integer `p` is
     /// the first element of the tuple and `q` is the second element
     /// of the tuple.
+    ///
+    /// # Named Items
+    /// ## Numerator
+    /// Numerator of the fraction.
+    /// ## Denominator
+    /// Denominator of the fraction/
     newtype BigFraction = (
         Numerator: BigInt,
         Denominator: BigInt

Standard/src/Optimization/Univariate.qs

@@ -9,7 +9,7 @@ namespace Microsoft.Quantum.Optimization {
     /// # Summary
     /// Represents the result of optimizing a univariate function.
     ///
-    /// # Input
+    /// # Named Items
     /// ## Coordinate
     /// Input at which an optimum was found.
     /// ## Value