Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ITensors"
uuid = "9136182c-28ba-11e9-034c-db9fb085ebd5"
authors = ["Matthew Fishman <[email protected]>", "Miles Stoudenmire <[email protected]>"]
version = "0.8.2"
version = "0.8.3"

[deps]
Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
Expand Down
1 change: 0 additions & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
HDF5 = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f"
ITensorMPS = "0d1a4710-d33b-49a5-8f18-73bdf49b47e2"
ITensors = "9136182c-28ba-11e9-034c-db9fb085ebd5"
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
Strided = "5e0ebb24-38b0-5f93-81fe-25c709ecae67"
Expand Down
45 changes: 3 additions & 42 deletions docs/settings.jl
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
using Documenter
using ITensors
using ITensorMPS

# Allows using ITensorMPS.jl docstrings in ITensors.jl documentation:
# https://github.com/JuliaDocs/Documenter.jl/issues/1734
DocMeta.setdocmeta!(ITensors, :DocTestSetup, :(using ITensors); recursive=true)
DocMeta.setdocmeta!(ITensorMPS, :DocTestSetup, :(using ITensorMPS); recursive=true)

sitename = "ITensors.jl"

settings = Dict(
# Allows using ITensorMPS.jl docstrings in ITensors.jl documentation:
# https://github.com/JuliaDocs/Documenter.jl/issues/1734
:modules => [ITensors, ITensorMPS],
:pages => [
"Introduction" => "index.md",
"Getting Started with ITensor" => [
Expand All @@ -21,56 +16,22 @@ settings = Dict(
"Enabling Debug Checks" => "getting_started/DebugChecks.md",
"Next Steps" => "getting_started/NextSteps.md",
],
"Tutorials" => [
"DMRG" => "tutorials/DMRG.md",
"Quantum Number Conserving DMRG" => "tutorials/QN_DMRG.md",
"MPS Time Evolution" => "tutorials/MPSTimeEvolution.md",
],
"Code Examples" => [
"ITensor Examples" => "examples/ITensor.md",
"MPS and MPO Examples" => "examples/MPSandMPO.md",
"DMRG Examples" => "examples/DMRG.md",
"Physics (SiteType) System Examples" => "examples/Physics.md",
],
"Documentation" => [
"Index" => "IndexType.md",
"Index collections" => "IndexSetType.md",
"ITensor" => "ITensorType.md",
"MPS and MPO" => "MPSandMPO.md",
"QN" => "QN.md",
"SiteType and op, state, val functions" => "SiteType.md",
"SiteTypes Included with ITensor" => "IncludedSiteTypes.md",
"DMRG" => [
"DMRG.md",
"Sweeps.md",
"ProjMPO.md",
"ProjMPOSum.md",
"Observer.md",
"DMRGObserver.md",
],
"OpSum" => "OpSum.md",
],
"Code Examples" => ["ITensor Examples" => "examples/ITensor.md"],
"Documentation" =>
["Index" => "IndexType.md", "ITensor" => "ITensorType.md", "QN" => "QN.md"],
"Frequently Asked Questions" => [
"Programming Language (Julia, C++, ...) FAQs" => "faq/JuliaAndCpp.md",
"DMRG FAQs" => "faq/DMRG.md",
"Quantum Number (QN) FAQs" => "faq/QN.md",
"ITensor Development FAQs" => "faq/Development.md",
"Relationship of ITensor to other tensor libraries FAQs" => "faq/RelationshipToOtherLibraries.md",
"Julia Package Manager FAQs" => "faq/JuliaPkg.md",
"High-Performance Computing FAQs" => "faq/HPC.md",
],
"Upgrade guides" => ["Upgrading from 0.1 to 0.2" => "UpgradeGuide_0.1_to_0.2.md"],
"ITensor indices and Einstein notation" => "Einsum.md",
"Advanced Usage Guide" => [
"Advanced Usage Guide" => "AdvancedUsageGuide.md",
"Multithreading" => "Multithreading.md",
"Running on GPUs" => "RunningOnGPUs.md",
"Symmetric (QN conserving) tensors: background and usage" => "QNTricks.md",
"Timing and profiling" => "CodeTiming.md",
"Contraction sequence optimization" => "ContractionSequenceOptimization.md",
"HDF5 File Formats" => "HDF5FileFormats.md",
],
"Developer Guide" => "DeveloperGuide.md",
],
:format => Documenter.HTML(; assets=["assets/favicon.ico"], prettyurls=false),
:doctest => true,
Expand Down
Loading
Loading