Skip to content

Commit f055ba5

Browse files
committed
move use to export; fix doc
1 parent edcf9d0 commit f055ba5

File tree

4 files changed

+14
-4
lines changed

4 files changed

+14
-4
lines changed

docs/make.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ doctest = false,
3131
clean = true,
3232
sitename = "QuantumClifford.jl",
3333
format = Documenter.HTML(size_threshold_ignore = ["API.md"]),
34-
modules = [QuantumClifford, QuantumClifford.Experimental.NoisyCircuits, QuantumClifford.ECC, QuantumInterface, QuantumCliffordHeckeExt, QuantumCliffordOscarExt, QuantumCliffordJuMPExt],
34+
modules = [QuantumClifford, QuantumClifford.Experimental.NoisyCircuits, QuantumClifford.ECC, QuantumClifford.GraphSim, QuantumInterface, QuantumCliffordHeckeExt, QuantumCliffordOscarExt, QuantumCliffordJuMPExt],
3535
warnonly = [:missing_docs],
3636
linkcheck = true,
3737
authors = "Stefan Krastanov",

docs/src/graphs.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# [Graph States](@id Graph-States)
22

3+
```@meta
4+
DocTestSetup = quote
5+
using QuantumClifford
6+
end
7+
```
8+
39
!!! warning "The `graphstate` API is not considered stable"
410
`graphstate` returns a lot of information about encoding a given stabilizer state in a graph. A different API is being designed that streamlines the work with graph states.
511

src/QuantumClifford.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1452,7 +1452,7 @@ include("useful_states.jl")
14521452
include("experimental/Experimental.jl")
14531453
#
14541454
include("./graphs/graphs.jl")
1455-
using .GraphSim: graphstate, graphstate!, graph_gatesequence, graph_gate
1455+
using .GraphSim
14561456
#
14571457
include("entanglement.jl")
14581458
#

src/graphs/graphs.jl

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
module GraphSim
22

3+
export graphstate, graphstate!, graph_gatesequence, graph_gate
4+
35
import Graphs: Graphs, nv, AbstractGraph
4-
using QuantumClifford
5-
using QuantumClifford: AbstractStabilizer
6+
using QuantumClifford: AbstractStabilizer, AbstractSingleQubitOperator,
7+
sId1, sInvPhase, sSQRTX, CliffordOperator, SingleQubitOperator,
8+
Stabilizer, sZ, sPhase, sX, sY, sHadamard, sInvSQRTX, @S_str, stabilizerview,
9+
canonicalize_gott!, phases, sCPHASE, affectedqubits, canonicalize!, tab
610
import QuantumClifford: nqubits, apply!
711

812
include("single_qubit_tables.jl")

0 commit comments

Comments
 (0)