Skip to content

Commit 5210dd3

Browse files
authoredSep 18, 2024··
Document the new redirect option (#1953)
1 parent 2c1a895 commit 5210dd3

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed
 

‎lib/mix/tasks/docs.ex

+3
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,9 @@ defmodule Mix.Tasks.Docs do
149149
* `:output` - Output directory for the generated docs; default: "doc".
150150
May be overridden by command line argument.
151151
152+
* `:redirects` - A map or list of tuples, where the key is the path to redirect from and the
153+
value is the path to redirect to. The extension is omitted in both cases, i.e `%{"old-readme" => "readme"}`
154+
152155
* `:skip_undefined_reference_warnings_on` - ExDoc warns when it can't create a `Mod.fun/arity`
153156
reference in the current project docs e.g. because of a typo. This list controls where to
154157
skip the warnings, for a given module/function/callback/type (e.g.: `["Foo", "Bar.baz/0"]`)

0 commit comments

Comments
 (0)
Please sign in to comment.