Skip to content

Add support section to docs #128

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

Merged
mtfishman merged 1 commit into from
Mar 24, 2025
Merged

Add support section to docs #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ITensorMPS"
uuid = "0d1a4710-d33b-49a5-8f18-73bdf49b47e2"
authors = ["Matthew Fishman <[email protected]>", "Miles Stoudenmire <[email protected]>"]
version = "0.3.12"
version = "0.3.13"

[deps]
Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
Expand Down
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@

Finite MPS and MPO methods based on the Julia version of [ITensor](https://www.itensor.org) ([ITensors.jl](https://github.com/ITensor/ITensors.jl)). See the [ITensorMPS.jl documentation](https://itensor.github.io/ITensorMPS.jl) for more details.

## Support

<img src="docs/src/assets/CCQ.png" width="20%" alt="Flatiron Center for Computational Quantum Physics logo.">

ITensorMPS.jl is supported by the Flatiron Institute, a division of the Simons Foundation.

## News

### ITensorMPS.jl v0.3 release notes
Expand Down
11 changes: 11 additions & 0 deletions docs/make_index.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
using Literate: Literate
using ITensorMPS: ITensorMPS

function ccq_logo(content)
include_ccq_logo = """
```@raw html
<img src="assets/CCQ.png" width="20%" alt="Flatiron Center for Computational Quantum Physics logo.">
```
"""
content = replace(content, "{CCQ_LOGO}" => include_ccq_logo)
return content
end

Literate.markdown(
joinpath(pkgdir(ITensorMPS), "examples", "README.jl"),
joinpath(pkgdir(ITensorMPS), "docs", "src");
flavor=Literate.DocumenterFlavor(),
name="index",
postprocess=ccq_logo,
)
9 changes: 9 additions & 0 deletions docs/make_readme.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
using Literate: Literate
using ITensorMPS: ITensorMPS

function ccq_logo(content)
include_ccq_logo = """
<img src="docs/src/assets/CCQ.png" width="20%" alt="Flatiron Center for Computational Quantum Physics logo.">
"""
content = replace(content, "{CCQ_LOGO}" => include_ccq_logo)
return content
end

Literate.markdown(
joinpath(pkgdir(ITensorMPS), "examples", "README.jl"),
joinpath(pkgdir(ITensorMPS));
flavor=Literate.CommonMarkFlavor(),
name="README",
preprocess=ccq_logo,
)
6 changes: 6 additions & 0 deletions examples/README.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@
# [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)

# Finite MPS and MPO methods based on the Julia version of [ITensor](https://www.itensor.org) ([ITensors.jl](https://github.com/ITensor/ITensors.jl)). See the [ITensorMPS.jl documentation](https://itensor.github.io/ITensorMPS.jl) for more details.

# ## Support
#
# {CCQ_LOGO}
#
# ITensorMPS.jl is supported by the Flatiron Institute, a division of the Simons Foundation.

# ## News
#
# ### ITensorMPS.jl v0.3 release notes
Expand Down
Loading