From 35fabf5cff0ef64d83485bec12d763f1721409d2 Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Thu, 11 Jul 2024 12:54:59 -0400 Subject: [PATCH] Prepare for 0.9.0 release --- CHANGELOG.md | 19 +++++++++++++++++++ changelog.d/20240527_110205_jsick_DM_43638.md | 17 ----------------- changelog.d/20240620_135505_jsick_DM_44542.md | 19 ------------------- 3 files changed, 19 insertions(+), 36 deletions(-) delete mode 100644 changelog.d/20240527_110205_jsick_DM_43638.md delete mode 100644 changelog.d/20240620_135505_jsick_DM_44542.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 09144e9..557b9de 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,25 @@ + +## 0.9.0 (2024-07-11) + +### Backwards-incompatible changes + +- We've "vendored" sphinx-basic-ng into the Technote project itself. This is to prepare for changing the technote theme to a two column layout. + +- Technote no longer uses the `sphinx-basic-ng` theme. Users that depended in the `sphinx-basic-ng` themes HTML and class structure for theming will need to update their CSS. + +### New features + +- Technote now features a two-column layout. The left column contains the table of contents and metadata, while the right column contains the content. This layout allows for wide content to "bleed" into the whitespace to the right of the content column. With this change, we've dropped the CSS patterns from the `sphinx-basic-ng` theme. The Technote layout is now built around CSS grid. + +- Wide content (such as figures, tables, and code blocks) can now extend past the content column if the author sets the `technote-wide-content` class on the content. This class is applied as a `figclass` option in figures or as a preceding `rst-class` directive to tables and code blocks. + +### Other changes + +- Adopt ruff for formatting (dropping Black). + ## 0.8.0 (2024-05-02) diff --git a/changelog.d/20240527_110205_jsick_DM_43638.md b/changelog.d/20240527_110205_jsick_DM_43638.md deleted file mode 100644 index f427c0f..0000000 --- a/changelog.d/20240527_110205_jsick_DM_43638.md +++ /dev/null @@ -1,17 +0,0 @@ - - -### Backwards-incompatible changes - -- We've "vendored" sphinx-basic-ng into the Technote project itself. This is to prepare for changing the technote theme to a two column layout. - -### New features - -- - -### Bug fixes - -- - -### Other changes - -- Adopt ruff for formatting (dropping Black). diff --git a/changelog.d/20240620_135505_jsick_DM_44542.md b/changelog.d/20240620_135505_jsick_DM_44542.md deleted file mode 100644 index 625eaae..0000000 --- a/changelog.d/20240620_135505_jsick_DM_44542.md +++ /dev/null @@ -1,19 +0,0 @@ - - -### Backwards-incompatible changes - -- - -### New features - -- Technote now features a two-column layout. The left column contains the table of contents and metadata, while the right column contains the content. This layout allows for wide content to "bleed" into the whitespace to the right of the content column. With this change, we've essentially dropped the CSS patterns from the `sphinx-basic-ng` theme. The Technote layout is now built around CSS grid. - -- Wide content (such as figures, tables, and code blocks) can now extend past the content column if the author sets the `technote-wide-content` class on the content. This class is applied as a `figclass` option in figures or as a preceeding `rst-class` directive to tables and code blocks. - -### Bug fixes - -- - -### Other changes - --