MicrosoftDocs / quantum-docs-pr

Sources of the Microsoft Quantum Development Kit documentation
https://docs.microsoft.com/quantum/
Creative Commons Attribution 4.0 International
81 stars 114 forks source link

Reference docs for 0.14.2011.120134. #1124

Closed vxfield closed 3 years ago

vxfield commented 3 years ago

Merge QDK Nov 2020 release Reference Docs into main.

opbld30 commented 3 years ago

Docs Build status updates of commit c4722b4:

:x: Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
[]() :x:Error Details

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

opbld31 commented 3 years ago

Docs Build status updates of commit c4722b4:

:warning: Validation status: warnings

File Status Preview URL Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampampbyoracle.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampampbyoraclephases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampampbyreflectionphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampampobliviousbyoraclephases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampampobliviousbyreflectionphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampampphasesfixedpoint.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampampphasesstandard.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampamprotationtoreflectionphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampamprusbyoracle.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.amplitudeamplificationfrompartialreflections.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.amplitudeamplificationfromstatepreparation.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.applyamplitudeamplification.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.applyfixedpointamplification.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.applyobliviousamplitudeamplification.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.applytargetstatereflectionoracle.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.fixedpointreflectionphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.obliviousamplitudeamplificationfrompartialreflections.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.obliviousamplitudeamplificationfromstatepreparation.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.reflectionphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.reflectionstart.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.rotationphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.rotationphasesasreflectionphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.standardamplitudeamplification.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.standardreflectionphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.targetstatereflectionoracle.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.addconstantfxp.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.addfxp.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.addi.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyinnerttkadder.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyinnerttkadderwithoutcarry.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyleoperationonphasele.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyleoperationonphaselea.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyleoperationonphaselec.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyleoperationonphaseleca.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applymajorityinplace.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyoutercdkmadder.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyouterttkadder.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyphaseleoperationonle.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyphaseleoperationonlea.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyphaseleoperationonlec.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyphaseleoperationonleca.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyreversedopbe.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyreversedopbea.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyreversedopbec.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyreversedopbeca.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyreversedople.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyreversedoplea.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyreversedoplec.md :warning:Warning View Details
api/qsharp/microsoft.quantum.arithmetic.applyreversedopleca.md :warning:Warning View Details

This comment lists only the first 50 files in the pull request.

api/qsharp/microsoft.quantum.amplitudeamplification.ampampbyoracle.md

api/qsharp/microsoft.quantum.amplitudeamplification.ampampbyoraclephases.md

api/qsharp/microsoft.quantum.amplitudeamplification.ampampbyreflectionphases.md

api/qsharp/microsoft.quantum.amplitudeamplification.ampampobliviousbyoraclephases.md

api/qsharp/microsoft.quantum.amplitudeamplification.ampampobliviousbyreflectionphases.md

api/qsharp/microsoft.quantum.amplitudeamplification.ampampphasesfixedpoint.md

api/qsharp/microsoft.quantum.amplitudeamplification.ampampphasesstandard.md

api/qsharp/microsoft.quantum.amplitudeamplification.ampamprotationtoreflectionphases.md

api/qsharp/microsoft.quantum.amplitudeamplification.ampamprusbyoracle.md

api/qsharp/microsoft.quantum.amplitudeamplification.amplitudeamplificationfrompartialreflections.md

api/qsharp/microsoft.quantum.amplitudeamplification.amplitudeamplificationfromstatepreparation.md

api/qsharp/microsoft.quantum.amplitudeamplification.applyamplitudeamplification.md

api/qsharp/microsoft.quantum.amplitudeamplification.applyfixedpointamplification.md

api/qsharp/microsoft.quantum.amplitudeamplification.applyobliviousamplitudeamplification.md

api/qsharp/microsoft.quantum.amplitudeamplification.applytargetstatereflectionoracle.md

api/qsharp/microsoft.quantum.amplitudeamplification.fixedpointreflectionphases.md

api/qsharp/microsoft.quantum.amplitudeamplification.md

api/qsharp/microsoft.quantum.amplitudeamplification.obliviousamplitudeamplificationfrompartialreflections.md

api/qsharp/microsoft.quantum.amplitudeamplification.obliviousamplitudeamplificationfromstatepreparation.md

api/qsharp/microsoft.quantum.amplitudeamplification.reflectionphases.md

api/qsharp/microsoft.quantum.amplitudeamplification.reflectionstart.md

api/qsharp/microsoft.quantum.amplitudeamplification.rotationphases.md

api/qsharp/microsoft.quantum.amplitudeamplification.rotationphasesasreflectionphases.md

api/qsharp/microsoft.quantum.amplitudeamplification.standardamplitudeamplification.md

api/qsharp/microsoft.quantum.amplitudeamplification.standardreflectionphases.md

api/qsharp/microsoft.quantum.amplitudeamplification.targetstatereflectionoracle.md

api/qsharp/microsoft.quantum.arithmetic.addconstantfxp.md

api/qsharp/microsoft.quantum.arithmetic.addfxp.md

api/qsharp/microsoft.quantum.arithmetic.addi.md

api/qsharp/microsoft.quantum.arithmetic.applyinnerttkadder.md

api/qsharp/microsoft.quantum.arithmetic.applyinnerttkadderwithoutcarry.md

api/qsharp/microsoft.quantum.arithmetic.applyleoperationonphasele.md

api/qsharp/microsoft.quantum.arithmetic.applyleoperationonphaselea.md

api/qsharp/microsoft.quantum.arithmetic.applyleoperationonphaselec.md

api/qsharp/microsoft.quantum.arithmetic.applyleoperationonphaseleca.md

api/qsharp/microsoft.quantum.arithmetic.applymajorityinplace.md

api/qsharp/microsoft.quantum.arithmetic.applyoutercdkmadder.md

api/qsharp/microsoft.quantum.arithmetic.applyouterttkadder.md

api/qsharp/microsoft.quantum.arithmetic.applyphaseleoperationonle.md

api/qsharp/microsoft.quantum.arithmetic.applyphaseleoperationonlea.md

api/qsharp/microsoft.quantum.arithmetic.applyphaseleoperationonlec.md

api/qsharp/microsoft.quantum.arithmetic.applyphaseleoperationonleca.md

api/qsharp/microsoft.quantum.arithmetic.applyreversedopbe.md

api/qsharp/microsoft.quantum.arithmetic.applyreversedopbea.md

api/qsharp/microsoft.quantum.arithmetic.applyreversedopbec.md

api/qsharp/microsoft.quantum.arithmetic.applyreversedopbeca.md

api/qsharp/microsoft.quantum.arithmetic.applyreversedople.md

api/qsharp/microsoft.quantum.arithmetic.applyreversedoplea.md

api/qsharp/microsoft.quantum.arithmetic.applyreversedoplec.md

api/qsharp/microsoft.quantum.arithmetic.applyreversedopleca.md

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

geduardo commented 3 years ago

There are many warnings. I guess it is because the new builder isn't adding some required fields to the metadata. Also, some many xrefs give an error, I think it is because they're in lower case.

vxfield commented 3 years ago

@cgranade, is this related to the new DocGen? Can you give me some pointers on how to fix these warning? And do you think we can release QDK it and just update the docs later? Or this should block the release?

PS: I closed this PR because it's based on the old RC build. The new build 0.14.2011.120240 is still in progress.

vxfield commented 3 years ago

@cgranade, let me know if this PR makes sense: https://github.com/microsoft/qsharp-compiler/pull/756

cgranade commented 3 years ago

@cgranade, is this related to the new DocGen? Can you give me some pointers on how to fix these warning? And do you think we can release QDK it and just update the docs later? Or this should block the release?

PS: I closed this PR because it's based on the old RC build. The new build 0.14.2011.120240 is still in progress.

@vxfield: I think this shouldn't be blocking, both since these are warnings, and because the required modifications can be made in-place post-release if needed.