Skip to content

Commit 0db2726

Browse files
committed
Add a changelog
1 parent 54b7a39 commit 0db2726

File tree

4 files changed

+33
-2
lines changed

4 files changed

+33
-2
lines changed

docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
build/
2+
src/changelog.md

docs/Project.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[deps]
2+
Changelog = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e"
23
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
34
IJulia = "7073ff75-c697-5162-941a-fcdaad2a7d2a"
45

docs/make.jl

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1+
import Changelog
12
using Documenter, IJulia
23

4+
# Build the changelog
5+
Changelog.generate(
6+
Changelog.Documenter(),
7+
joinpath(@__DIR__, "src/_changelog.md"),
8+
joinpath(@__DIR__, "src/changelog.md"),
9+
repo="JuliaLang/IJulia.jl"
10+
)
311

412
# Make docs to `docs/build` directory
5-
makedocs(
13+
makedocs(;
14+
repo=Remotes.GitHub("JuliaLang", "IJulia.jl"),
615
modules=[IJulia],
716
sitename="IJulia",
817
format=Documenter.HTML(;
@@ -21,7 +30,8 @@ makedocs(
2130
"library/public.md",
2231
"library/internals.md",
2332
],
24-
],
33+
"changelog.md"
34+
]
2535
)
2636

2737
# Deploy docs

docs/src/_changelog.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
```@meta
2+
CurrentModule = IJulia
3+
```
4+
5+
# Changelog
6+
7+
This documents notable changes in IJulia.jl. The format is based on [Keep a
8+
Changelog](https://keepachangelog.com).
9+
10+
## Unreleased
11+
12+
### Added
13+
- [`installkernel()`](@ref) now supports a `displayname` argument to customize
14+
the kernel display name ([#1137]).
15+
16+
### Fixed
17+
- The internal heartbeat thread will now shut down cleanly ([#1135],
18+
[#1144]). This should prevent segfaults upon exit.
19+
- Various fixes to the messaging code to be compliant with Jupyter ([#1138]).

0 commit comments

Comments
 (0)