Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pages render check did not run on API docs change #2228

Open
Eric-Arellano opened this issue Nov 1, 2024 · 0 comments
Open

Pages render check did not run on API docs change #2228

Eric-Arellano opened this issue Nov 1, 2024 · 0 comments

Comments

@Eric-Arellano
Copy link
Collaborator

Eric-Arellano commented Nov 1, 2024

The CI run did not capture that a page 500s due to bad Latex. The log shows that the pages render check only ran for 1s and didn't actually check the changed pages.

GitHub Actions log
Run echo "docs/api/qiskit/dev/qiskit.circuit.library.AndGate.mdx
  echo "docs/api/qiskit/dev/qiskit.circuit.library.AndGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.BitwiseXorGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.InnerProductGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.OrGate.mdx
  docs/api/qiskit/dev/qiskit.quantum_info.SparseObservable.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveIdentityEquivalent.mdx
  docs/api/qiskit/dev/assembler.mdx
  docs/api/qiskit/dev/circuit.mdx
  docs/api/qiskit/dev/circuit_library.mdx
  docs/api/qiskit/dev/circuit_singleton.mdx
  docs/api/qiskit/dev/compiler.mdx
  docs/api/qiskit/dev/converters.mdx
  docs/api/qiskit/dev/passmanager.mdx
  docs/api/qiskit/dev/providers_fake_provider.mdx
  docs/api/qiskit/dev/pulse.mdx
  docs/api/qiskit/dev/qasm2.mdx
  docs/api/qiskit/dev/qasm3.mdx
  docs/api/qiskit/dev/qiskit.circuit.BreakLoopOp.mdx
  docs/api/qiskit/dev/qiskit.circuit.ContinueLoopOp.mdx
  docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.mdx
  docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.ForLoopOp.mdx
  docs/api/qiskit/dev/qiskit.circuit.Gate.mdx
  docs/api/qiskit/dev/qiskit.circuit.IfElseOp.mdx
  docs/api/qiskit/dev/qiskit.circuit.Instruction.mdx
  docs/api/qiskit/dev/qiskit.circuit.InstructionSet.mdx
  docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx
  docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx
  docs/api/qiskit/dev/qiskit.circuit.WhileLoopOp.mdx
  docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.mdx
  docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.AND.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CSGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CXGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CYGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.CZGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.HGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.IGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.IQP.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.Initialize.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.Isometry.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.LinearFunction.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.MCMTGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.MSGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.QFT.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.QFTGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.RGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.RXGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.RYGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.SGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.SXGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.TGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.UCPauliRotGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.UCRXGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.UCRYGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.UCRZGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.UGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.XGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.YGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.ZGate.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx
  docs/api/qiskit/dev/qiskit.circuit.library.iSwapGate.mdx
  docs/api/qiskit/dev/qiskit.dagcircuit.DAGCircuit.mdx
  docs/api/qiskit/dev/qiskit.dagcircuit.DAGDependency.mdx
  docs/api/qiskit/dev/qiskit.providers.Backend.mdx
  docs/api/qiskit/dev/qiskit.providers.BackendV1.mdx
  docs/api/qiskit/dev/qiskit.providers.BackendV2.mdx
  docs/api/qiskit/dev/qiskit.providers.BackendV2Converter.mdx
  docs/api/qiskit/dev/qiskit.providers.QubitProperties.mdx
  docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.mdx
  docs/api/qiskit/dev/qiskit.providers.convert_to_target.mdx
  docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake127QPulseV1.mdx
  docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake1Q.mdx
  docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake20QV1.mdx
  docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake27QPulseV1.mdx
  docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake5QV1.mdx
  docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake7QPulseV1.mdx
  docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx
  docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx
  docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.mdx
  docs/api/qiskit/dev/qiskit.providers.models.Command.mdx
  docs/api/qiskit/dev/qiskit.providers.models.PulseDefaults.mdx
  docs/api/qiskit/dev/qiskit.pulse.InstructionScheduleMap.mdx
  docs/api/qiskit/dev/qiskit.pulse.Schedule.mdx
  docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.mdx
  docs/api/qiskit/dev/qiskit.pulse.channels.AcquireChannel.mdx
  docs/api/qiskit/dev/qiskit.pulse.channels.ControlChannel.mdx
  docs/api/qiskit/dev/qiskit.pulse.channels.DriveChannel.mdx
  docs/api/qiskit/dev/qiskit.pulse.channels.MeasureChannel.mdx
  docs/api/qiskit/dev/qiskit.pulse.channels.MemorySlot.mdx
  docs/api/qiskit/dev/qiskit.pulse.channels.RegisterSlot.mdx
  docs/api/qiskit/dev/qiskit.pulse.channels.SnapshotChannel.mdx
  docs/api/qiskit/dev/qiskit.pulse.instructions.Acquire.mdx
  docs/api/qiskit/dev/qiskit.pulse.instructions.Delay.mdx
  docs/api/qiskit/dev/qiskit.pulse.instructions.Play.mdx
  docs/api/qiskit/dev/qiskit.pulse.instructions.Reference.mdx
  docs/api/qiskit/dev/qiskit.pulse.instructions.RelativeBarrier.mdx
  docs/api/qiskit/dev/qiskit.pulse.instructions.SetFrequency.mdx
  docs/api/qiskit/dev/qiskit.pulse.instructions.SetPhase.mdx
  docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftFrequency.mdx
  docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftPhase.mdx
  docs/api/qiskit/dev/qiskit.pulse.instructions.Snapshot.mdx
  docs/api/qiskit/dev/qiskit.pulse.instructions.TimeBlockade.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.Constant.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.Cos.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.Drag.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.Gaussian.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.GaussianDeriv.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquare.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquareDrag.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.Sawtooth.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.Sech.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.SechDeriv.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.Sin.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.Square.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.SymbolicPulse.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.Triangle.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.Waveform.mdx
  docs/api/qiskit/dev/qiskit.pulse.library.gaussian_square_echo.mdx
  docs/api/qiskit/dev/qiskit.quantum_info.CNOTDihedral.mdx
  docs/api/qiskit/dev/qiskit.quantum_info.Clifford.mdx
  docs/api/qiskit/dev/qiskit.quantum_info.DensityMatrix.mdx
  docs/api/qiskit/dev/qiskit.quantum_info.Operator.mdx
  docs/api/qiskit/dev/qiskit.quantum_info.Pauli.mdx
  docs/api/qiskit/dev/qiskit.quantum_info.PauliList.mdx
  docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.mdx
  docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.mdx
  docs/api/qiskit/dev/qiskit.quantum_info.Statevector.mdx
  docs/api/qiskit/dev/qiskit.result.BaseReadoutMitigator.mdx
  docs/api/qiskit/dev/qiskit.result.CorrelatedReadoutMitigator.mdx
  docs/api/qiskit/dev/qiskit.result.LocalReadoutMitigator.mdx
  docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx
  docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx
  docs/api/qiskit/dev/qiskit.transpiler.InstructionProperties.mdx
  docs/api/qiskit/dev/qiskit.transpiler.Target.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.AlignMeasures.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.DynamicalDecoupling.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.PulseGates.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.mdx
  docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.mdx
  docs/api/qiskit/dev/qiskit.visualization.dag_drawer.mdx
  docs/api/qiskit/dev/qpy.mdx
  docs/api/qiskit/dev/quantum_info.mdx
  docs/api/qiskit/dev/result.mdx
  docs/api/qiskit/dev/scheduler.mdx
  docs/api/qiskit/dev/synthesis.mdx
  docs/api/qiskit/dev/transpiler.mdx
  docs/api/qiskit/dev/transpiler_passes.mdx
  docs/api/qiskit/dev/transpiler_plugins.mdx
  docs/api/qiskit/dev/transpiler_preset.mdx
  docs/api/qiskit/dev/transpiler_synthesis_plugins.mdx
  docs/api/qiskit/dev/visualization.mdx" > changed.txt
  npm run check:pages-render -- --from-file changed.txt
  shell: /usr/bin/bash -e {0}

> [email protected] check:pages-render
> tsx scripts/js/commands/checkPagesRender.ts --from-file changed.txt
✅ All 0 pages render without crashing

Jake is also wondering if there's a way to get Katex to render the Latex in Qiskit CI so that this gets caught in Qiskit CI rather than ours: Qiskit/qiskit#13388 (review).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

No branches or pull requests

1 participant