From 65e8796ec436d622c6381bcf71dc84d06a0587d6 Mon Sep 17 00:00:00 2001 From: Fredrik Ekre Date: Tue, 16 Apr 2024 02:07:34 +0200 Subject: [PATCH] Use Changelog.jl. --- CHANGELOG.md | 348 ++++++++++++++++++++++----------------------- docs/Manifest.toml | 9 +- docs/Project.toml | 1 + docs/make.jl | 16 ++- 4 files changed, 191 insertions(+), 183 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index eb9cdad5..1a106577 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,63 +5,61 @@ 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). - - -## [2.17.0] - 2024-04-14 +## [v2.17.0] - 2024-04-14 ### Added - Literate can now output [Quarto](https://quarto.org/) notebooks (markdown documents with the `.qmd` file extension) by passing `flavor = Literate.QuartoFlavor()` to `Literate.markdown`. This feature is marked as experimental since it has not been widely tested and the Quarto-specific syntax may change before Literate version 3 depending on - what the community wants or needs. ([#199][github-199], [#200][github-200]) + what the community wants or needs. ([#199], [#200]) -## [2.16.1] - 2024-01-04 +## [v2.16.1] - 2024-01-04 ### Fixed -- Fix removal of Documenter-style `@ref` links spanning multiple lines. ([#224][github-224], - [#233][github-2233]) +- Fix removal of Documenter-style `@ref` links spanning multiple lines. ([#224], + [#233]) -## [2.16.0] - 2023-11-08 +## [v2.16.0] - 2023-11-08 ### Added -- "Soft" scoping rules (see e.g. https://github.com/JuliaLang/SoftGlobalScope.jl) are now +- "Soft" scoping rules (see e.g. ) are now available for code execution (markdown and notebook output). This is enabled by default for Jupyter notebook output (to mimic how the IJulia kernel works), and disabled otherwise. Soft scope rules can be enabled/disabled with the `softscope :: Bool` - configuration variable. ([#227][github-227], [#230][github-230]) + configuration variable. ([#227], [#230]) ### Changed - The minimum Julia version requirement for Literate >= 2.16.0 is now 1.6.0 (from 1.0.0). - ([#230][github-230]) + ([#230]) -## [2.15.1] - 2023-11-08 +## [v2.15.1] - 2023-11-08 ### Fixed - Fix a bug where `Literate.markdown` with `execute=true` would (try to) output images in the wrong directory. This only occured when passing a relative output directory. - ([#228][github-228], [#229][github-229]) + ([#228], [#229]) -## [2.15.0] - 2023-09-05 +## [v2.15.0] - 2023-09-05 ### Added - Documenter style `@raw html` blocks are automatically handled in Jupyter notebook output (similar to how Documenter style ` ```math ` blocks are rewritten to `$$` blocks). - ([#222][github-222], [#223][github-223]) + ([#222], [#223]) -## [2.14.2] - 2023-08-28 +## [v2.14.2] - 2023-08-28 ### Fixed -- Remove double newline in `Literate.script` output. ([#221][github-221]) +- Remove double newline in `Literate.script` output. ([#221]) -## [2.14.1] - 2023-08-04 +## [v2.14.1] - 2023-08-04 ### Fixed - Update generated `EditURL` to use a relative path instead and let Documenter figure out the remote repository. This is required for Documenter version 1, but works also on - Documenter 0.27. ([#219][github-219]) + Documenter 0.27. ([#219]) -## [2.14.0] - 2022-09-22 +## [v2.14.0] - 2022-09-22 ### Changed - Image filenames resulting from executing markdown files (`Literate.markdown(...; execute=true)`) have changed from a number based on the hash of the source block to the format - `{name}-{blocknumber}.(svg|png|...)`. ([#204][github-204], - [#205][github-205]) + `{name}-{blocknumber}.(svg|png|...)`. ([#204], + [#205]) -## [2.13.4] - 2022-06-03 +## [v2.13.4] - 2022-06-03 ### Fixed - Automatic head branch detection (introduced in version 2.11.0) caused a performance regression since the `git remote show` command takes ~1 second. For documentation builds @@ -71,83 +69,83 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 head branch on a per-repo basis, so the 1 second delay should only be noticed on the first run of the first file in a repo. As noted in the changelog entry for 2.11.0 it is also possible to specify the head branch by passing the `edit_commit` keyword argument. Doing - so will now completely skip the slow `git` command. ([8054d26][8054d26]) + so will now completely skip the slow `git` command. ([8054d26]) -## [2.13.3] - 2022-05-21 +## [v2.13.3] - 2022-05-21 ### Fixed - Update remote HEAD branch detection to use `addenv` instead of `setenv` such that e.g. ssh-agent variables are available to the git command. Also set `GIT_SSH_COMMAND='ssh -o "BatchMode yes"'` to supress prompts when using ssh. - ([#197][github-197]) + ([#197]) -## [2.13.2] - 2022-04-22 +## [v2.13.2] - 2022-04-22 ### Fixed - Set current working directory for markdown execution to the output directory, just like - notebook execution. ([#195][github-195]) + notebook execution. ([#195]) - Set the apparent source file to the output file for markdown and notebook execution. - ([#195][github-195]) + ([#195]) -## [2.13.1] - 2022-04-12 +## [v2.13.1] - 2022-04-12 ### Fixed -- Disable git terminal prompt when detecting remote HEAD branch. ([#194][github-194]) +- Disable git terminal prompt when detecting remote HEAD branch. ([#194]) -## [2.13.0] - 2022-02-18 +## [v2.13.0] - 2022-02-18 ### Changed - "Markdown stdlib-style" inline math (e.g. ``` ``f(x) = x^2`` ```) is now replaced with "notebook style" math (`$f(x) = x^2$`) for notebook output. This is already the case for - display math (```` ```math ````). ([#116][github-116], [#190][github-190]) + display math (```` ```math ````). ([#116], [#190]) ### Fixed - Lines with trailing `#hide` are not shown in output of Markdown execution with Documenter - flavor. ([#166][github-166], [#188][github-188]) + flavor. ([#166], [#188]) -## [2.12.1] - 2022-02-10 +## [v2.12.1] - 2022-02-10 ### Fixed - Make sure Markdown execution picks up new definitions of display methods (by running - in the latest "world age"). ([#187][github-187]) + in the latest "world age"). ([#187]) -## [2.12.0] - 2022-02-01 +## [v2.12.0] - 2022-02-01 ### Changed - User input configurations can now be `AbstractDict`s instead of just `Dict`s. - ([#185][github-185], [#186][github-186]) + ([#185], [#186]) -## [2.11.0] - 2022-01-25 +## [v2.11.0] - 2022-01-25 ### Added - Literate now tries to figure out the branch/commit that `EditURL` should point to automatically instead of always defaulting to `"master"`. For typical setups the auto-detection should be sufficient, but you can also set it explicitly by passing - `edit_commit`, for example `edit_commit = "main"`. ([#179][github-179], [#184][github-184]) + `edit_commit`, for example `edit_commit = "main"`. ([#179], [#184]) -## [2.10.0] - 2022-01-24 +## [v2.10.0] - 2022-01-24 ### Added -- Markdown execution now also support `image/svg+xml`. ([#182][github-182], [#183][github-183]) +- Markdown execution now also support `image/svg+xml`. ([#182], [#183]) -## [2.9.4] - 2021-10-18 +## [v2.9.4] - 2021-10-18 ### Fixed -- Fix multiline comment support for `\r\n` line endings. ([#171][github-171], [#172][github-172]) +- Fix multiline comment support for `\r\n` line endings. ([#171], [#172]) -## [2.9.3] - 2021-09-01 +## [v2.9.3] - 2021-09-01 ### Fixed - Fix named `@examples` from `Literate.markdown` to not contain spaces even if the source - filename does. ([#168][github-168], [#169][github-169]) + filename does. ([#168], [#169]) -## [2.9.2] - 2021-08-16 +## [v2.9.2] - 2021-08-16 ### Fixed -- Fix multiline comment support for `\r\n` line endings. ([#165][github-165], [#167][github-167]) +- Fix multiline comment support for `\r\n` line endings. ([#165], [#167]) -## [2.9.1] - 2021-07-30 +## [v2.9.1] - 2021-07-30 ### Fixed - Automatic URLs from `@__NBVIEWER_ROOT_URL__` and `@__BINDER_ROOT_URL__` now follow the convention [used in Documenter.jl](https://github.com/JuliaDocs/Documenter.jl/pull/1298) - to ignore build version information. ([#162][github-162], [#163][github-163]) + to ignore build version information. ([#162], [#163]) -## [2.9.0] - 2021-07-09 +## [v2.9.0] - 2021-07-09 ### Added - Added "Franklin flavored" markdown output for usage with [Franklin] (https://franklinjl.org/). Enable by passing the `flavor` keyword argument: ```julia Literate.markdown(...; flavor = Literate.FranklinFlavor()) ``` - ([#146][github-146], [#147][github-147], [#156][github-156]) + ([#146], [#147], [#156]) - Added "Documenter flavored" markdown output as a replacement for `documenter=true`, and "CommonMark flavored" markdown output as a replacement for `documenter=false`. Enable by passing the `flavor` keyword argument: @@ -155,181 +153,169 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 Literate.markdown(...; flavor = Literate.DocumenterFlavor()) Literate.markdown(...; flavor = Literate.CommonMarkFlavor()) ``` - ([#159][github-159]) + ([#159]) - Added option to use multiline markdown strings (`md""" ... """`) as markdown sections. - To enable, pass `mdstrings=true`. ([#152][github-152], [#149][github-149]) + To enable, pass `mdstrings=true`. ([#152], [#149]) ### Changed - The default code fence for markdown output have been changed to 4 (instead of 3) backticks to allow input files with 3 backticks, which is common in e.g. - docstrings or multiline `Cmd`. ([#144][github-144], [#145][github-145]) + docstrings or multiline `Cmd`. ([#144], [#145]) - Replacement of Documenter-style `@ref` and `@id` elements are now removed unconditionally instead of conditionally based on the (now deprecated) `documenter` keyword argument. - ([#159][github-159]) + ([#159]) ### Deprecated - The `documenter` keyword argument has been deprecated. For `Literate.markdown` the the replacement is to use `flavor = Literate.DocumenterFlavor()` or `flavor = Literate.CommonMarkFlavor()` as appropriate (see above). For `Literate.notebook` and `Literate.script` the option is now unused (see above - regarding `@ref` and `@id`), and no replacement is necessary. ([#159][github-159]) + regarding `@ref` and `@id`), and no replacement is necessary. ([#159]) -## [2.8] - 2021-01-19 +## v2.8 - 2021-01-19 ### Added - Execution of notebooks now capture output of `display(x)` and `display(mime, x)` - ([ceff7a3][ceff7a3]). + ([ceff7a3]). -## [2.7] - 2021-09-12 +## v2.7 - 2021-09-12 ### Added - Multiline-style Julia comments (`#= ... =#`) can now be used for markdown input - ([dc409d0][dc409d0]). + ([dc409d0]). -## [2.6] - 2020-08-15 +## v2.6 - 2020-08-15 ### Added - New end-of-line token `#hide` which filters out the line *after* execution in - `Literate.markdown(...; execute=true)` ([6d1aec9][6d1aec9]). -- Markdown execution now captures the `text/markdown` MIME ([e08ca0a][e08ca0a]). + `Literate.markdown(...; execute=true)` ([6d1aec9]). +- Markdown execution now captures the `text/markdown` MIME ([e08ca0a]). -## [2.5] - 2020-05-14 +## v2.5 - 2020-05-14 ### Changed -- The output directory now defaults to `pwd()` ([2ba316a][2ba316a]). +- The output directory now defaults to `pwd()` ([2ba316a]). -## [2.4] - 2020-04-23 +## v2.4 - 2020-04-23 ### Added - Markdown output can now be executed and the result included in the output by pasing `execute=true` to `Literate.markdown`. Currently captures the following MIMEs: - `text/plain`, `image/png`, and `image/jpeg` ([7e89fdb][7e89fdb]). + `text/plain`, `image/png`, and `image/jpeg` ([7e89fdb]). -## [2.3] - 2020-03-03 +## v2.3 - 2020-03-03 ### Added - Filter tokens `#md`, `#nb`, and `#jl`, as well as their negated counterparts, can now - be placed at the end of lines ([b0806ed][b0806ed]). + be placed at the end of lines ([b0806ed]). -## [2.2] - 2019-11-26 +## v2.2 - 2019-11-26 ### Added - Configuration can now be passed as a `config::Dict` keyword argument to the generators - ([0f9e836][0f9e836]). -- Link macros now works when running on GitLab CI ([4e71b15][4e71b15]). + ([0f9e836]). +- Link macros now works when running on GitLab CI ([4e71b15]). - Literate now supports more configuration for e.g. URL's that `@__REPO_ROOT_URL__` and - friends expand to ([4e71b15][4e71b15]). + friends expand to ([4e71b15]). -## [2.1] - 2019-10-30 +## v2.1 - 2019-10-30 ### Added -- Link macros now works when running on GitHub Actions ([cf2b552][cf2b552]). +- Link macros now works when running on GitHub Actions ([cf2b552]). -## [2.0] - 2019-07-19 +## v2.0 - 2019-07-19 ### Added -- Negated filter tokens (`#!nb`, `#!md` and `#!jl`) are now supported ([1d02868][1d02868]). -- Notebook output now support cell metadata with the `%%`-format ([0872a96][0872a96]). +- Negated filter tokens (`#!nb`, `#!md` and `#!jl`) are now supported ([1d02868]). +- Notebook output now support cell metadata with the `%%`-format ([0872a96]). ### Changed - **BREAKING** The link macros `@__REPO_ROOT_URL__`, `@__NBVIEWER_ROOT_URL__` - and `@__BINDER_ROOT_URL__` no longer include a trailing `/` ([7af5414][7af5414]). + and `@__BINDER_ROOT_URL__` no longer include a trailing `/` ([7af5414]). - **BREAKING** The (undocumented) feature of Documenter continued blocks now - requires an explicit `#+` chunk splitter ([36e8c21][36e8c21]). + requires an explicit `#+` chunk splitter ([36e8c21]). - The link macros `@__REPO_ROOT_URL__`, `@__NBVIEWER_ROOT_URL__` now expands to correct - paths when documentation is built with DocumentationGenerator.jl ([7af5414][7af5414]). + paths when documentation is built with DocumentationGenerator.jl ([7af5414]). -## [1.1] - 2019-04-05 +## v1.1 - 2019-04-05 ### Added - New link macro `@__BINDER_ROOT_URL__` for linking to notebooks mybinder.org - ([fa64dcd][fa64dcd]). + ([fa64dcd]). -## [1.0] - 2019-03-06 +## v1.0 - 2019-03-06 First stable release of Literate.jl, see https://discourse.julialang.org/t/ann-literate-jl/10651 for release announcement. -[7af5414]: https://github.com/fredrikekre/Literate.jl/commit/7af541461672c3098cc99c471377f0d379839fe8 -[36e8c21]: https://github.com/fredrikekre/Literate.jl/commit/36e8c210478a8be83ce0b2ce961ecd5c1abc8b45 -[1d02868]: https://github.com/fredrikekre/Literate.jl/commit/1d0286818f4946caf84420736cd64608a776d294 -[0872a96]: https://github.com/fredrikekre/Literate.jl/commit/0872a96a88dbf3d7647e6e78612cb9b7ed300428 -[fa64dcd]: https://github.com/fredrikekre/Literate.jl/commit/fa64dcd796543b2ea8f7e036f397f42549bd87f5 -[cf2b552]: https://github.com/fredrikekre/Literate.jl/commit/cf2b5525507217b6552e9c36f63419eddb5df58f -[0f9e836]: https://github.com/fredrikekre/Literate.jl/commit/0f9e836d68f238becd3e193b22ebdad06e4d7ffa -[4e71b15]: https://github.com/fredrikekre/Literate.jl/commit/4e71b159e5ce392c23e6f18116f96803191354c3 -[b0806ed]: https://github.com/fredrikekre/Literate.jl/commit/b0806edb6707d03c73bcb0829e96be336229bbeb -[7e89fdb]: https://github.com/fredrikekre/Literate.jl/commit/7e89fdbffdfc56a08caee47287429b4611f85684 -[2ba316a]: https://github.com/fredrikekre/Literate.jl/commit/2ba316ac90713cc6bdeaeaefd357bb3d847373cb -[e08ca0a]: https://github.com/fredrikekre/Literate.jl/commit/e08ca0a19bd5e61dac778ddf4aaf6cef37532e48 -[6d1aec9]: https://github.com/fredrikekre/Literate.jl/commit/6d1aec90b13c6ad888be0fdc77583e9c525b5dc1 -[dc409d0]: https://github.com/fredrikekre/Literate.jl/commit/dc409d0f43a6282bee4e28e8e12bb6309942e5d5 -[ceff7a3]: https://github.com/fredrikekre/Literate.jl/commit/ceff7a36be2a9152d853257bac97be00d915ba8e -[8054d26]: https://github.com/fredrikekre/Literate.jl/commit/8054d2630b72bc190913b9b92cdb16e367b1ea51 - -[github-116]: https://github.com/fredrikekre/Literate.jl/issues/116 -[github-144]: https://github.com/fredrikekre/Literate.jl/issues/144 -[github-145]: https://github.com/fredrikekre/Literate.jl/pull/145 -[github-146]: https://github.com/fredrikekre/Literate.jl/pull/146 -[github-147]: https://github.com/fredrikekre/Literate.jl/pull/147 -[github-149]: https://github.com/fredrikekre/Literate.jl/issues/149 -[github-152]: https://github.com/fredrikekre/Literate.jl/pull/152 -[github-156]: https://github.com/fredrikekre/Literate.jl/pull/156 -[github-159]: https://github.com/fredrikekre/Literate.jl/pull/159 -[github-162]: https://github.com/fredrikekre/Literate.jl/issues/162 -[github-163]: https://github.com/fredrikekre/Literate.jl/pull/163 -[github-165]: https://github.com/fredrikekre/Literate.jl/issues/165 -[github-166]: https://github.com/fredrikekre/Literate.jl/issues/166 -[github-167]: https://github.com/fredrikekre/Literate.jl/pull/167 -[github-168]: https://github.com/fredrikekre/Literate.jl/issues/168 -[github-169]: https://github.com/fredrikekre/Literate.jl/pull/169 -[github-171]: https://github.com/fredrikekre/Literate.jl/issues/171 -[github-172]: https://github.com/fredrikekre/Literate.jl/pull/172 -[github-179]: https://github.com/fredrikekre/Literate.jl/issues/179 -[github-182]: https://github.com/fredrikekre/Literate.jl/issues/182 -[github-183]: https://github.com/fredrikekre/Literate.jl/pull/183 -[github-184]: https://github.com/fredrikekre/Literate.jl/pull/184 -[github-185]: https://github.com/fredrikekre/Literate.jl/issues/185 -[github-186]: https://github.com/fredrikekre/Literate.jl/pull/186 -[github-187]: https://github.com/fredrikekre/Literate.jl/pull/187 -[github-188]: https://github.com/fredrikekre/Literate.jl/pull/188 -[github-190]: https://github.com/fredrikekre/Literate.jl/pull/190 -[github-194]: https://github.com/fredrikekre/Literate.jl/pull/194 -[github-195]: https://github.com/fredrikekre/Literate.jl/pull/195 -[github-197]: https://github.com/fredrikekre/Literate.jl/issues/197 -[github-199]: https://github.com/fredrikekre/Literate.jl/issues/199 -[github-200]: https://github.com/fredrikekre/Literate.jl/pull/200 -[github-204]: https://github.com/fredrikekre/Literate.jl/issues/204 -[github-205]: https://github.com/fredrikekre/Literate.jl/pull/205 -[github-219]: https://github.com/fredrikekre/Literate.jl/pull/219 -[github-221]: https://github.com/fredrikekre/Literate.jl/pull/221 -[github-222]: https://github.com/fredrikekre/Literate.jl/issues/222 -[github-223]: https://github.com/fredrikekre/Literate.jl/pull/223 -[github-224]: https://github.com/fredrikekre/Literate.jl/issues/224 -[github-227]: https://github.com/fredrikekre/Literate.jl/issues/227 -[github-228]: https://github.com/fredrikekre/Literate.jl/issues/228 -[github-229]: https://github.com/fredrikekre/Literate.jl/pull/229 -[github-230]: https://github.com/fredrikekre/Literate.jl/pull/230 -[github-233]: https://github.com/fredrikekre/Literate.jl/pull/233 - -[Unreleased]: https://github.com/fredrikekre/Literate.jl/compare/v2.17.0...HEAD -[2.17.0]: https://github.com/fredrikekre/Literate.jl/compare/v2.16.1...v2.17.0 -[2.16.1]: https://github.com/fredrikekre/Literate.jl/compare/v2.16.0...v2.16.1 -[2.16.0]: https://github.com/fredrikekre/Literate.jl/compare/v2.15.1...v2.16.0 -[2.15.1]: https://github.com/fredrikekre/Literate.jl/compare/v2.15.0...v2.15.1 -[2.15.0]: https://github.com/fredrikekre/Literate.jl/compare/v2.14.2...v2.15.0 -[2.14.2]: https://github.com/fredrikekre/Literate.jl/compare/v2.14.1...v2.14.2 -[2.14.1]: https://github.com/fredrikekre/Literate.jl/compare/v2.14.0...v2.14.1 -[2.14.0]: https://github.com/fredrikekre/Literate.jl/compare/v2.13.3...v2.14.0 -[2.13.4]: https://github.com/fredrikekre/Literate.jl/compare/v2.13.3...v2.13.4 -[2.13.3]: https://github.com/fredrikekre/Literate.jl/compare/v2.13.2...v2.13.3 -[2.13.2]: https://github.com/fredrikekre/Literate.jl/compare/v2.13.1...v2.13.2 -[2.13.1]: https://github.com/fredrikekre/Literate.jl/compare/v2.13.0...v2.13.1 -[2.13.0]: https://github.com/fredrikekre/Literate.jl/compare/v2.12.1...v2.13.0 -[2.12.1]: https://github.com/fredrikekre/Literate.jl/compare/v2.12.0...v2.12.1 -[2.12.0]: https://github.com/fredrikekre/Literate.jl/compare/v2.11.0...v2.12.0 -[2.11.0]: https://github.com/fredrikekre/Literate.jl/compare/v2.10.0...v2.11.0 -[2.10.0]: https://github.com/fredrikekre/Literate.jl/compare/v2.9.4...v2.10.0 -[2.9.4]: https://github.com/fredrikekre/Literate.jl/compare/v2.9.3...v2.9.4 -[2.9.3]: https://github.com/fredrikekre/Literate.jl/compare/v2.9.2...v2.9.3 -[2.9.2]: https://github.com/fredrikekre/Literate.jl/compare/v2.9.1...v2.9.2 -[2.9.1]: https://github.com/fredrikekre/Literate.jl/compare/v2.9.0...v2.9.1 -[2.9.0]: https://github.com/fredrikekre/Literate.jl/compare/v2.8.1...v2.9.0 -[2.8]: https://github.com/fredrikekre/Literate.jl/compare/v2.7.0...v2.8.1 -[2.7]: https://github.com/fredrikekre/Literate.jl/compare/v2.6.0...v2.7.0 -[2.6]: https://github.com/fredrikekre/Literate.jl/compare/v2.5.1...v2.6.0 -[2.5]: https://github.com/fredrikekre/Literate.jl/compare/v2.4.0...v2.5.1 -[2.4]: https://github.com/fredrikekre/Literate.jl/compare/v2.3.1...v2.4.0 -[2.3]: https://github.com/fredrikekre/Literate.jl/compare/v2.2.1...v2.3.1 -[2.2]: https://github.com/fredrikekre/Literate.jl/compare/v2.1.1...v2.2.1 -[2.1]: https://github.com/fredrikekre/Literate.jl/compare/v2.0.4...v2.1.1 -[2.0]: https://github.com/fredrikekre/Literate.jl/compare/v1.1.0...v2.0.4 -[1.1]: https://github.com/fredrikekre/Literate.jl/compare/v1.0.5...v1.1.0 -[1.0]: https://github.com/fredrikekre/Literate.jl/tree/v1.0.5 + + +[v2.9.0]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.0 +[v2.9.1]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.1 +[v2.9.2]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.2 +[v2.9.3]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.3 +[v2.9.4]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.4 +[v2.10.0]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.10.0 +[v2.11.0]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.11.0 +[v2.12.0]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.12.0 +[v2.12.1]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.12.1 +[v2.13.0]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.0 +[v2.13.1]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.1 +[v2.13.2]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.2 +[v2.13.3]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.3 +[v2.13.4]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.4 +[v2.14.0]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.0 +[v2.14.1]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.1 +[v2.14.2]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.2 +[v2.15.0]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.15.0 +[v2.15.1]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.15.1 +[v2.16.0]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.16.0 +[v2.16.1]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.16.1 +[v2.17.0]: https://github.com/fredrikekre/Literate.jl/releases/tag/v2.17.0 +[#116]: https://github.com/fredrikekre/Literate.jl/issues/116 +[#144]: https://github.com/fredrikekre/Literate.jl/issues/144 +[#145]: https://github.com/fredrikekre/Literate.jl/issues/145 +[#146]: https://github.com/fredrikekre/Literate.jl/issues/146 +[#147]: https://github.com/fredrikekre/Literate.jl/issues/147 +[#149]: https://github.com/fredrikekre/Literate.jl/issues/149 +[#152]: https://github.com/fredrikekre/Literate.jl/issues/152 +[#156]: https://github.com/fredrikekre/Literate.jl/issues/156 +[#159]: https://github.com/fredrikekre/Literate.jl/issues/159 +[#162]: https://github.com/fredrikekre/Literate.jl/issues/162 +[#163]: https://github.com/fredrikekre/Literate.jl/issues/163 +[#165]: https://github.com/fredrikekre/Literate.jl/issues/165 +[#166]: https://github.com/fredrikekre/Literate.jl/issues/166 +[#167]: https://github.com/fredrikekre/Literate.jl/issues/167 +[#168]: https://github.com/fredrikekre/Literate.jl/issues/168 +[#169]: https://github.com/fredrikekre/Literate.jl/issues/169 +[#171]: https://github.com/fredrikekre/Literate.jl/issues/171 +[#172]: https://github.com/fredrikekre/Literate.jl/issues/172 +[#179]: https://github.com/fredrikekre/Literate.jl/issues/179 +[#182]: https://github.com/fredrikekre/Literate.jl/issues/182 +[#183]: https://github.com/fredrikekre/Literate.jl/issues/183 +[#184]: https://github.com/fredrikekre/Literate.jl/issues/184 +[#185]: https://github.com/fredrikekre/Literate.jl/issues/185 +[#186]: https://github.com/fredrikekre/Literate.jl/issues/186 +[#187]: https://github.com/fredrikekre/Literate.jl/issues/187 +[#188]: https://github.com/fredrikekre/Literate.jl/issues/188 +[#190]: https://github.com/fredrikekre/Literate.jl/issues/190 +[#194]: https://github.com/fredrikekre/Literate.jl/issues/194 +[#195]: https://github.com/fredrikekre/Literate.jl/issues/195 +[#197]: https://github.com/fredrikekre/Literate.jl/issues/197 +[#199]: https://github.com/fredrikekre/Literate.jl/issues/199 +[#200]: https://github.com/fredrikekre/Literate.jl/issues/200 +[#204]: https://github.com/fredrikekre/Literate.jl/issues/204 +[#205]: https://github.com/fredrikekre/Literate.jl/issues/205 +[#219]: https://github.com/fredrikekre/Literate.jl/issues/219 +[#221]: https://github.com/fredrikekre/Literate.jl/issues/221 +[#222]: https://github.com/fredrikekre/Literate.jl/issues/222 +[#223]: https://github.com/fredrikekre/Literate.jl/issues/223 +[#224]: https://github.com/fredrikekre/Literate.jl/issues/224 +[#227]: https://github.com/fredrikekre/Literate.jl/issues/227 +[#228]: https://github.com/fredrikekre/Literate.jl/issues/228 +[#229]: https://github.com/fredrikekre/Literate.jl/issues/229 +[#230]: https://github.com/fredrikekre/Literate.jl/issues/230 +[#233]: https://github.com/fredrikekre/Literate.jl/issues/233 +[0872a96]: https://github.com/fredrikekre/Literate.jl/commit/0872a96 +[0f9e836]: https://github.com/fredrikekre/Literate.jl/commit/0f9e836 +[1d02868]: https://github.com/fredrikekre/Literate.jl/commit/1d02868 +[2ba316a]: https://github.com/fredrikekre/Literate.jl/commit/2ba316a +[36e8c21]: https://github.com/fredrikekre/Literate.jl/commit/36e8c21 +[4e71b15]: https://github.com/fredrikekre/Literate.jl/commit/4e71b15 +[6d1aec9]: https://github.com/fredrikekre/Literate.jl/commit/6d1aec9 +[7af5414]: https://github.com/fredrikekre/Literate.jl/commit/7af5414 +[7e89fdb]: https://github.com/fredrikekre/Literate.jl/commit/7e89fdb +[8054d26]: https://github.com/fredrikekre/Literate.jl/commit/8054d26 +[b0806ed]: https://github.com/fredrikekre/Literate.jl/commit/b0806ed +[ceff7a3]: https://github.com/fredrikekre/Literate.jl/commit/ceff7a3 +[cf2b552]: https://github.com/fredrikekre/Literate.jl/commit/cf2b552 +[dc409d0]: https://github.com/fredrikekre/Literate.jl/commit/dc409d0 +[e08ca0a]: https://github.com/fredrikekre/Literate.jl/commit/e08ca0a +[fa64dcd]: https://github.com/fredrikekre/Literate.jl/commit/fa64dcd diff --git a/docs/Manifest.toml b/docs/Manifest.toml index 44644edf..91f3ecc3 100644 --- a/docs/Manifest.toml +++ b/docs/Manifest.toml @@ -2,7 +2,7 @@ julia_version = "1.10.2" manifest_format = "2.0" -project_hash = "a514502cefccae4ec924513b8a987563e2ea08f7" +project_hash = "2e078e25d2cbff6828e6677f0730b09dacc40677" [[deps.ANSIColoredPrinters]] git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c" @@ -41,6 +41,13 @@ git-tree-sha1 = "a4c43f59baa34011e303e76f5c8c91bf58415aaf" uuid = "83423d85-b0ee-5818-9007-b63ccbeb887a" version = "1.18.0+1" +[[deps.Changelog]] +git-tree-sha1 = "e579c6157598169ad4ef17263bdf3452b4a3e316" +repo-rev = "master" +repo-url = "https://github.com/JuliaDocs/Changelog.jl.git" +uuid = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e" +version = "1.1.0" + [[deps.CodecZlib]] deps = ["TranscodingStreams", "Zlib_jll"] git-tree-sha1 = "59939d8a997469ee05c4b4944560a820f9ba0d73" diff --git a/docs/Project.toml b/docs/Project.toml index 7416adfd..b3c20fb6 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,4 +1,5 @@ [deps] +Changelog = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306" Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80" diff --git a/docs/make.jl b/docs/make.jl index 64c1363d..195fa822 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -45,6 +45,18 @@ if haskey(ENV, "GITHUB_ACTIONS") write(joinpath(@__DIR__, "src/outputformats.md"), str) end +# Generate changelog +using Changelog +clog = joinpath(@__DIR__, "src", "changelog.md") +Changelog.generate( + Changelog.Documenter(), + joinpath(@__DIR__, "..", "CHANGELOG.md"), + clog; + repo = "fredrikekre/Literate.jl", +) +write(clog, replace(read(clog, String), r"^# Literate.jl changelog"m => "# **9.** Changelog")) + + makedocs( format = Documenter.HTML( assets = ["assets/custom.css", "assets/favicon.ico"], @@ -61,7 +73,9 @@ makedocs( "customprocessing.md", "documenter.md", "tips.md", - "generated/example.md"] + "generated/example.md", + "changelog.md", + ], ) deploydocs(