From 5de6720ec192210b60e8c21a67502f46ade4df4c Mon Sep 17 00:00:00 2001 From: Zach Daniel Date: Wed, 18 Sep 2024 06:55:02 -0400 Subject: [PATCH] docs: document the new redirect option --- lib/mix/tasks/docs.ex | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/mix/tasks/docs.ex b/lib/mix/tasks/docs.ex index 250d037fb..f202e7171 100644 --- a/lib/mix/tasks/docs.ex +++ b/lib/mix/tasks/docs.ex @@ -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"]`)