Skip to content

Interface and Perfect5 code #2

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.

Sign up for GitHub

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

Open
nzy1997 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Interface and Perfect5 code #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b92ecf
copy codes from QC.jl
nzy1997 May 30, 2025
dd027f2
edit interfaces and perfect5 code
nzy1997 May 30, 2025
bdd2544
make docs
nzy1997 May 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
QECCore = "b50d4dc9-2544-401f-bae9-a24ba40d0c7a"
8 changes: 7 additions & 1 deletion docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
using QECCore
using Documenter
using DocumenterCitations
using LiveServer

DocMeta.setdocmeta!(QECCore, :DocTestSetup, :(using QECCore); recursive=true)

makedocs(;
bib = CitationBibliography(joinpath(@__DIR__,"src/references.bib"),style=:authoryear)

makedocs(
plugins = [bib],
modules=[QECCore],
authors="nzy1997",
sitename="QECCore.jl",
Expand All @@ -15,6 +19,8 @@ makedocs(;
),
pages=[
"Home" => "index.md",
"References" => "references.md",
"Manual" => "man.md",
],
)

Expand Down
12 changes: 5 additions & 7 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ CurrentModule = QECCore
```

# QECCore
A repository for *quantum error correction* (QEC) codes.

Documentation for [QECCore](https://github.com/nzy1997/QECCore.jl).

```@index
```

```@autodocs
Modules = [QECCore]
```
## Quantum Code list
| Code name | Struct |
| -------- | ------- |
| Perfect 5-qubit code | [`Perfect5`](@ref) |
8 changes: 8 additions & 0 deletions docs/src/man.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Documentation for [QECCore](https://github.com/QuantumSavory/QECCore.jl).

```@index
```

```@autodocs
Modules = [QECCore]
```
Loading