diff --git a/docs/src/changelog.md b/CHANGELOG.md similarity index 100% rename from docs/src/changelog.md rename to CHANGELOG.md diff --git a/docs/.gitignore b/docs/.gitignore index 0587d7400..c5cc3ab56 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,4 +1,5 @@ build/ node_modules/ package-lock.json -Manifest.toml \ No newline at end of file +Manifest.toml +src/changelog.md \ No newline at end of file diff --git a/docs/make.jl b/docs/make.jl index 5922e4ee3..050917f5e 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -38,6 +38,9 @@ links = InterLinks( # include MPSKit in all doctests DocMeta.setdocmeta!(MPSKit, :DocTestSetup, :(using MPSKit, TensorKit); recursive = true) +# root CHANGELOG.md is canonical (visible on GitHub); copy it in for rendering +cp(joinpath(@__DIR__, "..", "CHANGELOG.md"), joinpath(@__DIR__, "src", "changelog.md"); force = true) + makedocs(; sitename = "MPSKit.jl", format = DocumenterVitepress.MarkdownVitepress(;