From 35b3a9545a9efeb8e0ac413765852665dc4b1814 Mon Sep 17 00:00:00 2001 From: Michael Goerz Date: Thu, 22 Feb 2024 12:51:28 -0500 Subject: [PATCH] Update the CHANGELOG --- CHANGELOG.md | 2 ++ Project.toml | 2 +- README.md | 3 ++- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f08d942988..5dedfd10d4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added * Added support for a `CollapsedDocStrings` key in every page's `@meta` block. Setting `CollapsedDocStrings = true` for a particular page essentially clicks the "Collapse all docstrings" in the navigation bar after the page loads, collapsing all docstrings on that page. This can make API documentation pages much more readable. ([#2282], [#2394]) +* Automatically write an `objects.inv` inventory file to be be included in every online deployment of the documentation. With the help of the [`DocumenterInterLinks` plugin](http://juliadocs.org/DocumenterInterLinks.jl/stable/), any other project using Documenter or [Sphinx](https://www.sphinx-doc.org/en/master/) can then externally link to any page, heading, or docstring in the documentation. ([#2366], [#2424]) +* Added a parameter `inventory_version` to the `HTML()` options that may be passed to `makedocs`. This option sets the `version` metadata field in the new `objects.inv` inventory file. In most cases, the project version for the inventory will be automatically detected from the main `Project.toml` file, respectively, during deployment in `deploydocs`, from the git tag of the release. Any project may still want to explicitly set `inventory_version` via, e.g., [`pkgversion(MyProject)`](https://docs.julialang.org/en/v1/base/base/#Base.pkgversion-Tuple{Module}) instead of relying on an auto-detected version. Projects with a non-standard setup (documentation-only-repos, monorepos) *should* modify their existing configuration to explicitly set `inventory_version`. ([#2449]) ### Changed diff --git a/Project.toml b/Project.toml index e63edf9729..1007ed064b 100644 --- a/Project.toml +++ b/Project.toml @@ -1,6 +1,6 @@ name = "Documenter" uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4" -version = "1.2.1" +version = "1.3.0-dev" [deps] ANSIColoredPrinters = "a4c015fc-c6ff-483c-b24f-f7ea428134e9" diff --git a/README.md b/README.md index d61c560ee9..68ab5b1742 100644 --- a/README.md +++ b/README.md @@ -43,8 +43,9 @@ Contributions are very welcome, as are feature requests and suggestions. Please There are several packages that extend Documenter in different ways. The JuliaDocs organization maintains: * [DocumenterCitations.jl](https://github.com/JuliaDocs/DocumenterCitations.jl) -* [DocumenterTools.jl](https://github.com/JuliaDocs/DocumenterTools.jl) +* [DocumenterInterLinks.jl](https://github.com/JuliaDocs/DocumenterInterLinks.jl) * [DocumenterMarkdown.jl](https://github.com/JuliaDocs/DocumenterMarkdown.jl) +* [DocumenterTools.jl](https://github.com/JuliaDocs/DocumenterTools.jl) Other third-party packages that can be combined with Documenter include: