Skip to content

Commit

Permalink
Document the new redirect option (#1953)
Browse files Browse the repository at this point in the history
  • Loading branch information
zachdaniel authored Sep 18, 2024
1 parent 2c1a895 commit 5210dd3
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions lib/mix/tasks/docs.ex
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,9 @@ defmodule Mix.Tasks.Docs do
* `:output` - Output directory for the generated docs; default: "doc".
May be overridden by command line argument.
* `:redirects` - A map or list of tuples, where the key is the path to redirect from and the
value is the path to redirect to. The extension is omitted in both cases, i.e `%{"old-readme" => "readme"}`
* `:skip_undefined_reference_warnings_on` - ExDoc warns when it can't create a `Mod.fun/arity`
reference in the current project docs e.g. because of a typo. This list controls where to
skip the warnings, for a given module/function/callback/type (e.g.: `["Foo", "Bar.baz/0"]`)
Expand Down

0 comments on commit 5210dd3

Please sign in to comment.