Skip to content

Commit

Permalink
Release 0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@goerz
goerz committed Jan 2, 2024
1 parent 8997dd6 commit 518ebd1
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 2 deletions.
4 changes: 2 additions & 2 deletions 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.1.0+dev"
version = "0.2.0"

[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Expand All @@ -11,7 +11,7 @@ MarkdownAST = "d0879d2d-cac2-40c8-9cee-1863dc0c7391"

[compat]
Documenter = "1"
DocInventories = ">=0.1"
DocInventories = "0.2.0"
Markdown = "1"
MarkdownAST = "0.1.2"
julia = "1.6"
27 changes: 27 additions & 0 deletions docs/src/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,32 @@
# DocumenterInterLinks.jl


```@eval
using Markdown
using Pkg
VERSION = Pkg.dependencies()[Base.UUID("d12716ef-a0f6-4df4-a9f1-a5a34e75c656")].version
github_badge = "[![Github](https://img.shields.io/badge/JuliaDocs-DocumenterInterLinks.jl-blue.svg?logo=github)](https://github.com/JuliaDocs/DocumenterInterLinks.jl)"
version_badge = "![v$VERSION](https://img.shields.io/badge/version-v$(replace("$VERSION", "-" => "--"))-green.svg)"
if get(ENV, "DOCUMENTER_BUILD_PDF", "") == ""
Markdown.parse("$github_badge $version_badge")
else
Markdown.parse("""
-----
On Github: [JuliaDocs/DocumenterInterLinks.jl](https://github.com/JuliaDocs/DocumenterInterLinks.jl)
Version: $VERSION
-----
""")
end
```

[DocumenterInterLinks.jl](https://github.com/JuliaDocs/DocumenterInterLinks.jl#readme) is a plugin for [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl) to link to external projects. It is interoperable with [InterSphinx](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html).

## Usage
Expand Down

2 comments on commit 518ebd1

@goerz
Copy link
Member Author

@goerz goerz commented on 518ebd1 Jan 2, 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/98030

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.0 -m "<description of version>" 518ebd1fac25689001b841c40177d38e3793e6ad
git push origin v0.2.0

Please sign in to comment.