Skip to content

Add documentation for Running a Model, Gathering Results, and quantum computing context#92

Open
Copilot wants to merge 4 commits intomasterfrom
copilot/update-documentation-guidelines
Open

Add documentation for Running a Model, Gathering Results, and quantum computing context#92
Copilot wants to merge 4 commits intomasterfrom
copilot/update-documentation-guidelines

Conversation

Copy link
Contributor

Copilot AI commented Dec 2, 2025

Addresses documentation gaps identified in #59: stub pages for "Running a Model" and "Gathering Results" manual sections, and missing context about quantum annealing in examples.

Manual Documentation

Running a Model (docs/src/manual/2-model.md):

  • Model creation with ToQUBO.Optimizer and solver selection
  • Variable types (binary, integer, continuous) and encoding
  • Linear/quadratic constraints and objectives
  • Optimization workflow and solution status checking
  • Multiple solution handling
  • Complete workflow example (tested via CI)

Gathering Results (docs/src/manual/3-results.md):

  • Solution status retrieval (termination, primal, summary)
  • Variable values and objective extraction (single/multi-solution)
  • Compilation introspection (time, status, source/target models)
  • Penalty coefficient access
  • QUBOTools integration
  • Complete results retrieval example (tested via CI)

Examples Enhanced

Added quantum computing context to each example:

  • Knapsack: Quantum advantage for NP-hard problems
  • Integer Factorization: Shor's algorithm context, scaling considerations
  • Portfolio Optimization: Quantum finance applications

Testing Infrastructure

Manual examples are now part of the CI testing infrastructure:

  • Converted code examples to @example blocks for automated testing via Documenter.jl
  • Added QUBODrivers to docs dependencies to support example execution
  • All documentation examples are validated during CI runs

Example Usage

using JuMP, ToQUBO, QUBODrivers

model = Model(() -> ToQUBO.Optimizer(ExactSampler.Optimizer))
@variable(model, x[1:3], Bin)
@constraint(model, x[1] + x[2] + x[3] <= 2)
@objective(model, Max, x[1] + 2*x[2] + 3*x[3])

optimize!(model)

# Multiple solutions from QUBO samplers
for i in 1:result_count(model)
    println("Solution $i: $(value.(x, result=i))")
end

> [!WARNING]
>
>

Original prompt

This section details on the original issue you should resolve

<issue_title>Write Docs</issue_title>
<issue_description>There are a few comments in #59 about documentation. I'm listing them and other topics here as tasks for another PR yet to be opened.

Manual

  • Tell how to run a model
  • How to gather results
  • How to adjust compiler settings

Booklet

  • Organize the booklet and the manual into separate files.
  • Quadratization
    • Better explain what stable quadratizations are1
    • Finish the primer on submodularity
  • Variable Encoding
    • Make the explanation uniform across different methods
    • Describe the methodology for the computation of the number of bits given an error tolerance2

Examples

  • "Mention how exciting is solving a problem with a quantum annealer maybe3"
  • Give more context for the prime factoring example4

</issue_description>

<agent_instructions>Aim to improve the documentation of this repository and the functions within it also including the section in the docs. The docs should build correctly</agent_instructions>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Footnotes

  1. @bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1096178231

  2. @bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1103288064

  3. @bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1095202165

  4. @joaquimg, @bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1095355993

Copilot AI changed the title [WIP] Update documentation for model running and results gathering Add documentation for Running a Model, Gathering Results, and quantum computing context Dec 2, 2025
Copilot AI requested a review from bernalde December 2, 2025 04:32
@bernalde
Copy link
Collaborator

bernalde commented Dec 3, 2025

@copilot consider the fact that there are now instructions for you to deploy the tests of this PR.

Copy link
Contributor Author

Copilot AI commented Dec 3, 2025

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/FluxML/MacroTools.jl/tarball/1e0228a030642014fe5cfe68c2c0a818f9e3f522
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/GunnarFarneback/Inflate.jl/tarball/d1b1b796e47d94588b3757fe84fbf65a5ec4a80d
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaArrays/StaticArrays.jl/tarball/b8693004b385c842357406e3af647701fe783f98
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaArrays/StaticArraysCore.jl/tarball/6ab403037779dae8c514bad259f32a447262455a
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaArrays/StructArrays.jl/tarball/9537ef82c42cdd8c5d443cbc359110cbb36bae10
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/Bzip2_jll.jl/tarball/1b96ea4a01afe0ea4090c5c8039690672dd13f2e
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/EarCut_jll.jl/tarball/e3290f2d49e661fbd94046d7e3726ffcb2d41053
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/HDF5_jll.jl/tarball/e94f84da9af7ce9c6be049e9067e511e17ff89ec
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/Hwloc_jll.jl/tarball/3d468106a05408f9f7b6f161d9e7715159af247b
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/Libiconv_jll.jl/tarball/be484f5c92fad0bd8acfef35fe017900b0b73809
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/MPICH_jll.jl/tarball/9341048b9f723f2ae2a72a5269ac2f15f80534dc
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/MPItrampoline_jll.jl/tarball/e214f2a20bdd64c04cd3e4ff62d3c9be7e969a59
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/MicrosoftMPI_jll.jl/tarball/bc95bf4149bf535c09602e3acdf950d9b4376227
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/OpenMPI_jll.jl/tarball/ab6596a9d8236041dcd59b5b69316f28a8753592
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/OpenSpecFun_jll.jl/tarball/1346c9208249809840c91b26703912dff463d335
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/XML2_jll.jl/tarball/80d3930c6347cfce7ccf96bd3bafdf079d9c0390
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/Xorg_libpciaccess_jll.jl/tarball/4909eb8f1cbf6bd4b1c30dd18b2ead9019ef2fad
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/libaec_jll.jl/tarball/1aa23f01927b2dac46db77a56b31088feee0a491
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaCI/BenchmarkTools.jl/tarball/7fecfb1123b8d0232218e2da0c213004ff15358d
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaCollections/DataStructures.jl/tarball/e357641bb3e0638d353c4b29ea0e40ea644066a6
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaCollections/IterTools.jl/tarball/42d5f897009e7ff2cf88db414a389e5ed1bdd023
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaCollections/OrderedCollections.jl/tarball/05868e21324cede2207c6f0f466b4bfef6d5e7ee
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaData/DataAPI.jl/tarball/abe83f3a2f1b857aac70ef8b269080af17764bbe
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaData/Parsers.jl/tarball/7d2f8f21da5db6a806faf7b9b292296da42b2810
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaData/StructTypes.jl/tarball/159331b30e94d7b11379037feeb9b690950cace8
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaData/Tables.jl/tarball/f2c1efbc8f3a609aadf318094f8fc5204bdaf344
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaDiff/DiffResults.jl/tarball/782dd5f4561f5d267313f23853baaaa4c52ea621
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaDiff/DiffRules.jl/tarball/23163d55f885173722d1e4cf0f6110cdbaf7e272
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaDiff/ForwardDiff.jl/tarball/cd33c7538e68650bd0ddbb3f5bd50a4a0fa95b50
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaDocs/DocStringExtensions.jl/tarball/7442a5dfe1ebb773c29cc2962a8980f47221d76c
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaGeo/GeoFormatTypes.jl/tarball/7528a7956248c723d01a0a9b0447bf254bf4da52
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaGeo/GeoInterface.jl/tarball/294e99f19869d0b0cb71aef92f19d03649d028d5
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaGeometry/GeometryBasics.jl/tarball/b62f2b2d76cee0d61a2ef2b3118cd2a3215d3134
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaGraphs/Graphs.jl/tarball/d80e8b7220b884117938b2d219487eea06f9e42e
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaGraphs/NetworkLayout.jl/tarball/f7466c23a7c5029dc99e8358e7ce5d81a117c364
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaIO/CodecBzip2.jl/tarball/84990fa864b7f2b4901901ca12736e45ee79068c
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaIO/CodecZlib.jl/tarball/962834c22b66e32aa10f7611c08c8ca4e20749a9
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaIO/HDF5.jl/tarball/114e20044677badbc631ee6fdc80a67920561a29
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaIO/JSON.jl/tarball/31e996f0a15c7b280ba9f76636b3ff9e2ae58c9a
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaIO/TranscodingStreams.jl/tarball/0c45878dcfdcfa8480052b6ab162cdd138781742
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaLang/Compat.jl/tarball/9d8a54ce4b17aa5bdce0ea5c34bc5e7c340d16ad
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaLang/PrecompileTools.jl/tarball/07a921781cab75691315adc645096ed5e370cb77
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaLinearAlgebra/ArnoldiMethod.jl/tarball/d57bd3762d308bded22c3b82d033bff85f6195c6
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaMath/IrrationalConstants.jl/tarball/b2d91fe939cae05960e760110b328288867b5758
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaMath/NaNMath.jl/tarball/9b8215b1ee9e78a293f99797cd31375471b2bcae
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaMath/SpecialFunctions.jl/tarball/f2685b435df2613e25fc10ad8c26dddb8640f547
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaObjects/ConstructionBase.jl/tarball/b4b092499347b18a015186eae3042f72267106cb
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaPackaging/JLLWrappers.jl/tarball/0533e564aae234aff59ab625543145446d8b6ec2
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaPackaging/Preferences.jl/tarball/0f27480397253da18fe2c12a4ba4eb9eb208bf3d
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaPackaging/Requires.jl/tarball/62389eeff14780bfe55195b7204c0d8738436d64
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaParallel/MPI.jl/tarball/c105fe467859e7f6e9a852cb15cb4301126fac07
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaPlots/Plots.jl/tarball/5c3d09cc4f31f5fc6af001c250bf1278733100ff
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaQUBO/PseudoBooleanOptimization.jl/tarball/25c571704525af1924c6e000bfe2757f5242cb77
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaQUBO/QUBODrivers.jl/tarball/b6ca8cbc973c104b0aa0659f2c89d90d3d48bb69
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaQUBO/QUBOTools.jl/tarball/8b458d939a1c1dcfb4e302818248603303efcb53
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaStats/LogExpFunctions.jl/tarball/13ca9e2586b89836fd20cccf56e57e2b9ae7f38f
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaStats/Statistics.jl/tarball/ae3bb1eb3bba077cd276bc5cfc337cc65c3075c0
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/JuliaWeb/URIs.jl/tarball/bef26fb046d031353ef97a82e3fdb6afe7f21b1a
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/fredo-dedup/JSONSchema.jl/tarball/d13f79c4242969874da7d00bda17d59bc7699aa7
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/jump-dev/JuMP.jl/tarball/b76f23c45d75e27e3e9cbd2ee68d8e39491052d0
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/jump-dev/MathOptInterface.jl/tarball/a2cbab4256690aee457d136752c404e001f27768
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/jump-dev/MutableArithmetics.jl/tarball/22df8573f8e7c593ac205455ca088989d0a2c7a0
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/mauro3/SimpleTraits.jl/tarball/be8eeac05ec97d379347584fa9fe2f5f76795bcb
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/queryverse/DataValueInterfaces.jl/tarball/bfc1187b79289637fa0ef6d4436ebdfe6905cbd6
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/queryverse/IteratorInterfaceExtensions.jl/tarball/a3f24677c21f5bbe9d2a714f95dcd58337fb2856
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/queryverse/TableTraits.jl/tarball/c06b2f539df1c6efa794486abfb6ed2022561a39
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/quinnj/JSON3.jl/tarball/411eccfe8aba0814ffa0fdf4860913ed09c34975
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/rafaqz/Extents.jl/tarball/b309b36a9e02fe7be71270dd8c0fd873625332b4
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • https://api.github.com/repos/rdeits/CommonSubexpressions.jl/tarball/cda2cfaebb4be89c9084adaca7dd7333369715c5
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (http block)
  • pkg.julialang.org
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.instantiate(); Pkg.test(test_args=[&#34;unit&#34;]) (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

@bernalde bernalde marked this pull request as ready for review December 17, 2025 19:23
Copy link
Collaborator

@bernalde bernalde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The examples is the docs should be made part of the testing infrastructure and tested via CI using Documenter.jl

Copy link
Contributor Author

Copilot AI commented Dec 17, 2025

The examples is the docs should be made part of the testing infrastructure and tested via CI using Documenter.jl

The manual examples are now tested via CI. Converted code blocks to @example blocks in manual/2-model.md and manual/3-results.md, and added QUBODrivers to docs dependencies. The documentation builds successfully with doctest enabled. (d51ae7d)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write Docs

2 participants