Skip to content

Docs/v0.3 updates

Docs/v0.3 updates #321

Triggered via pull request October 17, 2024 19:24
Status Success
Total duration 21m 13s
Artifacts

CI.yml

on: pull_request
Matrix: test
Fit to window
Zoom out
Zoom in

Annotations

12 warnings and 1 notice
Julia 1.10 - ubuntu-latest - x64 - pull_request
The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2, codecov/codecov-action@v2. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
Julia 1.10 - ubuntu-latest - x64 - pull_request
The following actions use a deprecated Node.js version and will be forced to run on node20: actions/checkout@v2, julia-actions/setup-julia@v1, actions/cache@4d4ae6ae148a43d0fd1eda1800170683e9882738, pyTooling/Actions/with-post-step@adef08d3bdef092282614f3b683897cefae82ee3, codecov/codecov-action@v2. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/utilities/utilities.jl#L46
duplicate docs found for 'QuantumCollocation.ProblemTemplates.UnitaryMinimumTimeProblem' in src/lib.md:4-6 ```@autodocs Modules = [QuantumCollocation.ProblemTemplates] ```
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/utilities/utilities.jl#L46
duplicate docs found for 'QuantumCollocation.EmbeddedOperators.EmbeddedOperator' in src/lib.md:39-41 ```@autodocs Modules = [QuantumCollocation.EmbeddedOperators] ```
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/utilities/utilities.jl#L46
duplicate docs found for 'QuantumCollocation.EmbeddedOperators.get_subspace_indices' in src/lib.md:39-41 ```@autodocs Modules = [QuantumCollocation.EmbeddedOperators] ```
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/utilities/utilities.jl#L46
duplicate docs found for 'QuantumCollocation.EmbeddedOperators.get_subspace_indices' in src/lib.md:39-41 ```@autodocs Modules = [QuantumCollocation.EmbeddedOperators] ```
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/utilities/utilities.jl#L46
invalid local link/image: file does not exist in src/contribution_guide.md link = @ast MarkdownAST.Link("docs/literate", "") do MarkdownAST.Text("docs/literate") end
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/utilities/utilities.jl#L46
Cannot resolve @ref for md"[`QuantumControlProblem`](@ref)" in src/lib.md. - No docstring found in doc for binding `QuantumCollocation.Problems.QuantumControlProblem`. - No docstring found in doc for binding `QuantumCollocation.Problems.QuantumControlProblem`.
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/utilities/utilities.jl#L46
22 docstrings not included in the manual: QuantumCollocation.Constraints.NonlinearEqualityConstraint QuantumCollocation.Constraints.FinalUnitaryFreePhaseFidelityConstraint :: Tuple{} QuantumCollocation.QuantumSystemUtils.operator_algebra :: Union{Tuple{Vector{<:AbstractMatrix{T}}}, Tuple{T}} where T<:Number QuantumCollocation.QuantumSystemTemplates.MultiTransmonSystem :: Tuple{AbstractVector{Float64}, AbstractVector{Float64}, AbstractMatrix{Float64}} QuantumCollocation.QuantumSystemTemplates.TransmonDipoleCoupling QuantumCollocation.QuantumSystemTemplates.RydbergChainSystem :: Tuple{} QuantumCollocation.Constraints.ComplexModulusContraint :: Tuple{Symbol, Float64, NamedTrajectories.StructNamedTrajectory.NamedTrajectory} QuantumCollocation.Constraints.ComplexModulusContraint :: Tuple{} QuantumCollocation.Problems.QuantumControlProblem QuantumCollocation.Constraints.constrain! :: Tuple{Ipopt.Optimizer, Vector{MathOptInterface.VariableIndex}, Vector{LinearConstraint}, NamedTrajectories.StructNamedTrajectory.NamedTrajectory} QuantumCollocation.Constraints.NonlinearInequalityConstraint QuantumCollocation.QuantumSystemTemplates.TransmonSystem :: Tuple{} QuantumCollocation.Constraints.EqualityConstraint QuantumCollocation.Dynamics.QuantumDynamics QuantumCollocation.QuantumSystemUtils.is_reachable :: Tuple{AbstractMatrix, AbstractVector{<:AbstractMatrix}} QuantumCollocation.QuantumSystemTemplates.lift :: Tuple{Char, Int64, Int64} QuantumCollocation.Constraints.FinalQuantumStateFidelityConstraint :: Tuple{Symbol, Float64, NamedTrajectories.StructNamedTrajectory.NamedTrajectory} QuantumCollocation.Problems.get_objective :: Tuple{QuantumControlProblem} QuantumCollocation.Problems.get_constraints :: Tuple{QuantumControlProblem} QuantumCollocation.Constraints.FinalFidelityConstraint :: Tuple{} QuantumCollocation.Constraints.trajectory_constraints :: Tuple{NamedTrajectories.StructNamedTrajectory.NamedTrajectory} QuantumCollocation.Constraints.FinalUnitaryFidelityConstraint :: Tuple{Symbol, Float64, NamedTrajectories.StructNamedTrajectory.NamedTrajectory} These are docstrings in the checked modules (configured with the modules keyword) that are not included in canonical @docs or @autodocs blocks.
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/html/HTMLWriter.jl#L1828
Generated HTML over size_threshold_warn limit: lib.md Generated file size: 116.74 (KiB) size_threshold_warn: 100.0 (KiB) size_threshold: 200.0 (KiB) HTML file: lib/index.html
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/html/HTMLWriter.jl#L807
For 8 @example blocks, the 'text/html' representation of the resulting object is above the threshold (example_size_threshold: 8192 bytes). - 8 blocks had 'image/png' fallback image representation available, using that. On pages: generated/examples/multilevel_transmon.md, generated/examples/two_qubit_gates.md, generated/quickstart.md
Documentation
The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
[julia-buildpkg] Caching of the julia depot was not detected
Consider using `julia-actions/cache` to speed up runs https://github.com/julia-actions/cache. To ignore, set input `ignore-no-cache: true`