Skip to content

docs: move the changelog to the repo root #498

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

Closed
lkdvos wants to merge 1 commit into from
+5 −1
Closed

docs: move the changelog to the repo root #498

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
0 docs/src/changelog.md → CHANGELOG.md
View file
Open in desktop
File renamed without changes.
3 changes: 2 additions & 1 deletion docs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
build/
node_modules/
package-lock.json
Manifest.toml
Manifest.toml
src/changelog.md
3 changes: 3 additions & 0 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(;
Expand Down
Loading