11using Documenter
22using ITensors
3- using ITensorMPS
43
54# Allows using ITensorMPS.jl docstrings in ITensors.jl documentation:
65# https://github.com/JuliaDocs/Documenter.jl/issues/1734
76DocMeta. setdocmeta! (ITensors, :DocTestSetup , :(using ITensors); recursive= true )
8- DocMeta. setdocmeta! (ITensorMPS, :DocTestSetup , :(using ITensorMPS); recursive= true )
97
108sitename = " ITensors.jl"
119
1210settings = Dict (
13- # Allows using ITensorMPS.jl docstrings in ITensors.jl documentation:
14- # https://github.com/JuliaDocs/Documenter.jl/issues/1734
15- :modules => [ITensors, ITensorMPS],
1611 :pages => [
1712 " Introduction" => " index.md" ,
1813 " Getting Started with ITensor" => [
@@ -21,56 +16,22 @@ settings = Dict(
2116 " Enabling Debug Checks" => " getting_started/DebugChecks.md" ,
2217 " Next Steps" => " getting_started/NextSteps.md" ,
2318 ],
24- " Tutorials" => [
25- " DMRG" => " tutorials/DMRG.md" ,
26- " Quantum Number Conserving DMRG" => " tutorials/QN_DMRG.md" ,
27- " MPS Time Evolution" => " tutorials/MPSTimeEvolution.md" ,
28- ],
29- " Code Examples" => [
30- " ITensor Examples" => " examples/ITensor.md" ,
31- " MPS and MPO Examples" => " examples/MPSandMPO.md" ,
32- " DMRG Examples" => " examples/DMRG.md" ,
33- " Physics (SiteType) System Examples" => " examples/Physics.md" ,
34- ],
35- " Documentation" => [
36- " Index" => " IndexType.md" ,
37- " Index collections" => " IndexSetType.md" ,
38- " ITensor" => " ITensorType.md" ,
39- " MPS and MPO" => " MPSandMPO.md" ,
40- " QN" => " QN.md" ,
41- " SiteType and op, state, val functions" => " SiteType.md" ,
42- " SiteTypes Included with ITensor" => " IncludedSiteTypes.md" ,
43- " DMRG" => [
44- " DMRG.md" ,
45- " Sweeps.md" ,
46- " ProjMPO.md" ,
47- " ProjMPOSum.md" ,
48- " Observer.md" ,
49- " DMRGObserver.md" ,
50- ],
51- " OpSum" => " OpSum.md" ,
52- ],
19+ " Code Examples" => [" ITensor Examples" => " examples/ITensor.md" ],
20+ " Documentation" =>
21+ [" Index" => " IndexType.md" , " ITensor" => " ITensorType.md" , " QN" => " QN.md" ],
5322 " Frequently Asked Questions" => [
5423 " Programming Language (Julia, C++, ...) FAQs" => " faq/JuliaAndCpp.md" ,
55- " DMRG FAQs" => " faq/DMRG.md" ,
56- " Quantum Number (QN) FAQs" => " faq/QN.md" ,
5724 " ITensor Development FAQs" => " faq/Development.md" ,
58- " Relationship of ITensor to other tensor libraries FAQs" => " faq/RelationshipToOtherLibraries.md" ,
5925 " Julia Package Manager FAQs" => " faq/JuliaPkg.md" ,
6026 " High-Performance Computing FAQs" => " faq/HPC.md" ,
6127 ],
6228 " Upgrade guides" => [" Upgrading from 0.1 to 0.2" => " UpgradeGuide_0.1_to_0.2.md" ],
63- " ITensor indices and Einstein notation" => " Einsum.md" ,
6429 " Advanced Usage Guide" => [
65- " Advanced Usage Guide" => " AdvancedUsageGuide.md" ,
6630 " Multithreading" => " Multithreading.md" ,
6731 " Running on GPUs" => " RunningOnGPUs.md" ,
68- " Symmetric (QN conserving) tensors: background and usage" => " QNTricks.md" ,
69- " Timing and profiling" => " CodeTiming.md" ,
7032 " Contraction sequence optimization" => " ContractionSequenceOptimization.md" ,
7133 " HDF5 File Formats" => " HDF5FileFormats.md" ,
7234 ],
73- " Developer Guide" => " DeveloperGuide.md" ,
7435 ],
7536 :format => Documenter. HTML (; assets= [" assets/favicon.ico" ], prettyurls= false ),
7637 :doctest => true ,
0 commit comments