microsoft/qdk
Publicmirrored from https://github.com/microsoft/qdkAvailable
source/compiler/qsc_doc_gen/src/table_of_contents.rs
31lines · modecode
| 1 | // Copyright (c) Microsoft Corporation. |
| 2 | // Licensed under the MIT License. |
| 3 | |
| 4 | /// Returns the string of the table of contents for the standard library. |
| 5 | /// This table of contents will be the content of the top-level index.md |
| 6 | /// created during documentation generation. |
| 7 | pub(super) fn table_of_contents() -> String { |
| 8 | "# Q# standard library |
| 9 | |
| 10 | The Q# standard library contains the following namespaces: |
| 11 | |
| 12 | | Namespace | Description | |
| 13 | | --------------------------------------------------------------- | -------------------------------------------------------------------- | |
| 14 | | [`Microsoft.Quantum.Core`](xref:Qdk.Microsoft.Quantum.Core-toc) | Re-exported functions. | |
| 15 | | [`Std.Arithmetic`](xref:Qdk.Std.Arithmetic-toc) | Items for working with quantum arithmetic operations. | |
| 16 | | [`Std.Arrays`](xref:Qdk.Std.Arrays-toc) | Items for working with arrays. | |
| 17 | | [`Std.Canon`](xref:Qdk.Std.Canon-toc) | Canonical implementations of common classical and quantum utilities. | |
| 18 | | [`Std.Convert`](xref:Qdk.Std.Convert-toc) | Items for converting between different types. | |
| 19 | | [`Std.Core`](xref:Qdk.Std.Core-toc) | Items for language built-in operations. | |
| 20 | | [`Std.Diagnostics`](xref:Qdk.Std.Diagnostics-toc) | Items for debugging and testing quantum programs. | |
| 21 | | [`Std.Intrinsic`](xref:Qdk.Std.Intrinsic-toc) | Items that provide core quantum operations. | |
| 22 | | [`Std.Logical`](xref:Qdk.Std.Logical-toc) | Boolean Logic functions. | |
| 23 | | [`Std.Math`](xref:Qdk.Std.Math-toc) | Items for classical math operations. | |
| 24 | | [`Std.Measurement`](xref:Qdk.Std.Measurement-toc) | Items for measuring quantum results. | |
| 25 | | [`Std.Random`](xref:Qdk.Std.Random-toc) | Items for creating random values. | |
| 26 | | [`Std.Range`](xref:Qdk.Std.Range-toc) | Items for working with ranges. | |
| 27 | | [`Std.ResourceEstimation`](xref:Qdk.Std.ResourceEstimation-toc) | Items for working with the Azure Quantum Resource Estimator. | |
| 28 | | [`Std.StatePreparation`](xref:Qdk.Std.StatePreparation-toc) | Items for preparing a quantum state. | |
| 29 | | [`Std.TableLookup`](xref:Qdk.Std.TableLookup-toc) | Items for performing quantum table lookups. | |
| 30 | ".to_string() |
| 31 | } |