Skip to content

feat: mark retired versions in the version dropdown - #2280

Merged
josevalim merged 1 commit into
elixir-lang:mainfrom
sofiabordagorry:feat/show_retired_versions
Oct 13, 2026
Merged

josevalim merged 1 commit into
elixir-lang:mainfrom
sofiabordagorry:feat/show_retired_versions

Conversation

@sofiabordagorry

Copy link
Copy Markdown
Contributor

What does this PR do?

Closes #2232

hexdocs adds "retired": true to versionNodes entries for retired versions (hexpm/hexdocs#95). This PR makes ExDoc show them as vX.Y.Z (retired) in the sidebar version dropdown (as suggested here)

It also documents the optional latest and retired keys in the versionNodes docs

How to test

Run mix docs and add a doc/docs_config.js like:

var versionNodes = [
  {version: "v0.41.0", url: "#", latest: true},
  {version: "v0.40.4", url: "#", retired: true},
  {version: "v0.40.3", url: "#"}
]

Then open doc/index.html: the dropdown shows v0.40.4 (retired).

@github-actions

Copy link
Copy Markdown

@josevalim

Copy link
Copy Markdown
Member

💚 💙 💜 💛 ❤️

@josevalim
josevalim merged commit ac18ca5 into elixir-lang:main Oct 13, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Show when hex package versions are retired

2 participants