Literate examples

Author: mtfishman

.gitignore

@@ -12,3 +12,4 @@ benchmark/*.json
 docs/Manifest.toml
 docs/build/
 docs/src/index.md
+docs/src/examples.md

Project.toml

@@ -1,7 +1,7 @@
 name = "ITensorNetworks"
 uuid = "2919e153-833c-4bdc-8836-1ea460a35fc7"
 authors = ["Matthew Fishman <[email protected]>, Joseph Tindall <[email protected]> and contributors"]
-version = "0.12.2"
+version = "0.12.3"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"

docs/Project.toml

@@ -1,9 +1,11 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
 ITensorNetworks = "2919e153-833c-4bdc-8836-1ea460a35fc7"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 
 [compat]
 Documenter = "1.10.0"
+Graphs = "1.12.1"
 ITensorNetworks = "0.12.0"
 Literate = "2.20.1"

docs/make.jl

@@ -1,12 +1,19 @@
-using ITensorNetworks: ITensorNetworks
 using Documenter: Documenter, DocMeta, deploydocs, makedocs
+using ITensorNetworks: ITensorNetworks
+using Literate: Literate
 
 DocMeta.setdocmeta!(
   ITensorNetworks, :DocTestSetup, :(using ITensorNetworks); recursive=true
 )
 
 include("make_index.jl")
 
+Literate.markdown(
+  joinpath(@__DIR__, "src", "examples.jl"),
+  joinpath(@__DIR__, "src");
+  flavor=Literate.DocumenterFlavor(),
+)
+
 makedocs(;
   modules=[ITensorNetworks],
   authors="ITensor developers <[email protected]> and contributors",
@@ -16,7 +23,7 @@ makedocs(;
     edit_link="main",
     assets=["assets/favicon.ico", "assets/extras.css"],
   ),
-  pages=["Home" => "index.md", "Reference" => "reference.md"],
+  pages=["Home" => "index.md", "Examples" => "examples.md", "Reference" => "reference.md"],
   warnonly=true,
 )
 

docs/src/examples.jl

@@ -0,0 +1,5 @@
+# # Examples
+
+using Graphs: path_graph
+using ITensorNetworks: ITensorNetwork
+tn = ITensorNetwork(path_graph(4); link_space=2)