Skip to content

Commit

Permalink
Release 0.2.5
Browse files Browse the repository at this point in the history
  • Loading branch information
@goerz
goerz committed Jan 27, 2024
1 parent 6dcf017 commit 638f63e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "DocumenterInterLinks"
uuid = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
authors = ["Michael Goerz <[email protected]>"]
version = "0.2.4+dev"
version = "0.2.5"

[deps]
CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193"
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A plugin for [Documenter.jl](https://documenter.juliadocs.org/) that enables lin

Loading `DocumenterInterLinks` in `docs/make.jl` causes Documenter to produce an "inventory file" `objects.inv` in the output folder, which should get deployed together with the documentation. This file contains a mapping from names to URLs for all link targets in the documentation.

Other projects may use this inventory file to resolve `@extref` links, see [External Citations](#external-citations).
Other projects may use this inventory file to resolve `@extref` links, see [External References](#external-references).


## Installation
Expand Down Expand Up @@ -56,7 +56,7 @@ The resulting plugin object that must be passed as an element of the `plugins` k
See [`docs/src/inventories`](https://github.com/JuliaDocs/DocumenterInterLinks.jl/tree/master/docs/src/inventories) for some exemplary inventory files in [TOML format](https://juliadocs.org/DocInventories.jl/stable/formats/#TOML-Format).


## External Citations
## External References

Instead of [Documenter's `@ref`](https://documenter.juliadocs.org/stable/man/syntax/#@ref-link), the `@extref` link target can be used to resolve the link via any of the available projects defined in the `InterLinks` plugin:

Expand Down

2 comments on commit 638f63e

@goerz
Copy link
Member Author

@goerz goerz commented on 638f63e Jan 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/99689

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.2.5 -m "<description of version>" 638f63ec69142a7e3f2b4138d3e5ea934fb5a0c8
git push origin v0.2.5

Please sign in to comment.