From a54b3452acd3dca02ee9605902ff09fa0ec93087 Mon Sep 17 00:00:00 2001 From: mtfishman Date: Mon, 6 May 2024 08:31:14 -0400 Subject: [PATCH] Add docs --- README.md | 7 +++++++ docs/Project.toml | 3 +++ docs/make.jl | 23 +++++++++++++++++++++++ docs/src/index.md | 14 ++++++++++++++ 4 files changed, 47 insertions(+) create mode 100644 docs/Project.toml create mode 100644 docs/make.jl create mode 100644 docs/src/index.md diff --git a/README.md b/README.md index 6c56278..cf554f4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,11 @@ # ITensorMPS.jl + +[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://itensor.github.io/ITensorMPS.jl/stable/) +[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://itensor.github.io/ITensorMPS.jl/dev/) +[![Build Status](https://github.com/ITensor/ITensorMPS.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ITensor/ITensorMPS.jl/actions/workflows/CI.yml?query=branch%3Amain) +[![Coverage](https://codecov.io/gh/ITensor/ITensorMPS.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/ITensorMPS.jl) +[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) + MPS and MPO methods based on ITensor (ITensors.jl). This package supercedes the MPS codes previously located in the ITensors.jl and ITensorTDVP.jl packages, including applications like DMRG, TDVP, applying MPO to MPS, applying gates, etc. diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..39303f4 --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,3 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +ITensorMPS = "10ea5e1e-0ede-47d2-81e8-27a421adbc4d" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..a7cedf8 --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,23 @@ +using ITensorMPS +using Documenter + +DocMeta.setdocmeta!(ITensorMPS, :DocTestSetup, :(using ITensorMPS); recursive=true) + +makedocs(; + modules=[ITensorMPS], + authors="ITensor developers", + sitename="ITensorMPS.jl", + format=Documenter.HTML(; + canonical="https://ITensor.github.io/ITensorMPS.jl", + edit_link="main", + assets=String[], + ), + pages=[ + "Home" => "index.md", + ], +) + +deploydocs(; + repo="github.com/ITensor/ITensorMPS.jl", + devbranch="main", +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..6dbda31 --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,14 @@ +```@meta +CurrentModule = ITensorMPS +``` + +# ITensorMPS + +Documentation for [ITensorMPS](https://github.com/ITensor/ITensorMPS.jl). + +```@index +``` + +```@autodocs +Modules = [ITensorMPS] +```