Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions BREAKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@

This document describes breaking changes in CTModels releases and how to migrate your code.

## [0.19.3-beta] - unreleased

### No Breaking Changes

This release is documentation-only. It fixes the docs build to emit SVG figures for
both the Plots and CairoMakie backends
([#423](https://github.com/control-toolbox/CTModels.jl/issues/423)), loads
`CairoMakie` with `import` so its `plot`/`plot!` no longer collide with Plots' in
`@docs` blocks ([#424](https://github.com/control-toolbox/CTModels.jl/issues/424)),
converts ordered lists to bullets across `src/` and `docs/src/`
([#421](https://github.com/control-toolbox/CTModels.jl/issues/421)) and re-runs
`JuliaFormatter` on `docs/make.jl`
([#425](https://github.com/control-toolbox/CTModels.jl/issues/425)). No runtime
behavior or public API changed; no migration required.

## [0.19.2-beta] - unreleased

### No Breaking Changes
Expand Down
32 changes: 32 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,38 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.19.3-beta] - unreleased

### 📚 Documentation

- **Force SVG figures in the docs build**
([#423](https://github.com/control-toolbox/CTModels.jl/issues/423)). Under
DocumenterVitepress every plot was emitted as PNG (Vitepress picks the highest
MIME priority rather than Documenter.HTML's SVG preference), degrading the
printed quality. The docs build now disables PNG output and activates the SVG
backend once, for both the Plots and CairoMakie backends.

- **No `plot` name collision in `@docs` blocks**
([#424](https://github.com/control-toolbox/CTModels.jl/issues/424)). `CairoMakie`
is now loaded with `import` (not `using`) in `docs/make.jl` so its generic
`plot`/`plot!` methods stay out of `Main` and no longer collide with Plots' in the
documentation `@docs` blocks, satisfying the meta "no-import" test.

- Converted ordered lists to bullet lists across `src/` and `docs/src/`
([#421](https://github.com/control-toolbox/CTModels.jl/issues/421)) for a
consistent Markdown rendering style.

### ♻️ Internal

- Re-ran `JuliaFormatter` on `docs/make.jl`
([#425](https://github.com/control-toolbox/CTModels.jl/issues/425)).

### ✅ Compatibility

- **No breaking changes**: this release only touches documentation sources and the
docs build configuration; no runtime behavior, public API, or migration is
affected.

## [0.19.2-beta] - unreleased

### 🔧 Fixed
Expand Down
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "CTModels"
uuid = "34c4fa32-2049-4079-8329-de33c2a22e2d"
version = "0.19.2-beta"
version = "0.19.3-beta"
authors = ["Olivier Cots <olivier.cots@toulouse-inp.fr>"]

[deps]
Expand Down
Loading