refactor: unify output directory handling across formatters

- Simplified the output directory structure for EPUB, HTML, and Markdown formatters by removing redundant build directory paths.
- Updated the `run` function in each formatter to directly use the output path for building.
- Enhanced the `update_output_for_formatter` function to streamline output path management in the documentation generation process.
- Adjusted related test cases to reflect the new output structure.

Author: yordis

lib/ex_doc/formatter/epub.ex

@@ -11,10 +11,11 @@ defmodule ExDoc.Formatter.EPUB do
   """
   @spec run([ExDoc.ModuleNode.t()], [ExDoc.ModuleNode.t()], ExDoc.Config.t()) :: String.t()
   def run(project_nodes, filtered_modules, config) when is_map(config) do
-    original_output = Path.expand(config.output)
+    # Store original output for build file before normalize_config creates temp path
+    original_output = config.output
     config = normalize_config(config)
-    build_dir = Path.join(original_output, ".build/epub")
-    build = Path.join(build_dir, ".build")
+
+    build = Path.join(original_output, ".build")
     output_setup(build, config)
     File.mkdir_p!(Path.join(config.output, "OEBPS"))
 

lib/ex_doc/formatter/html.ex

@@ -15,8 +15,7 @@ defmodule ExDoc.Formatter.HTML do
     config = normalize_config(config)
     config = %{config | output: Path.expand(config.output)}
 
-    build_dir = Path.join(config.output, ".build/html")
-    build = Path.join(build_dir, ".build")
+    build = Path.join(config.output, ".build")
     output_setup(build, config)
 
     project_nodes = Formatter.render_all(project_nodes, filtered_modules, ".html", config, [])

lib/ex_doc/formatter/markdown.ex

@@ -13,8 +13,8 @@ defmodule ExDoc.Formatter.Markdown do
     Utils.unset_warned()
 
     config = normalize_config(config)
-    build_dir = Path.join(config.output, ".build/markdown")
-    build = Path.join(build_dir, ".build")
+
+    build = Path.join(config.output, ".build")
     output_setup(build, config)
 
     extras = Formatter.build_extras(config, ".md")

lib/mix/tasks/docs.ex

@@ -605,7 +605,12 @@ defmodule Mix.Tasks.Docs do
 
     results =
       for formatter <- options[:formatters] do
-        index = generator.(project, version, Keyword.put(options, :formatter, formatter))
+        formatter_options =
+          options
+          |> Keyword.put(:formatter, formatter)
+          |> update_output_for_formatter(formatter)
+
+        index = generator.(project, version, formatter_options)
         Mix.shell().info([:green, "View #{inspect(formatter)} docs at #{inspect(index)}"])
 
         if cli_opts[:open] do
@@ -651,6 +656,12 @@ defmodule Mix.Tasks.Docs do
     Keyword.put(options, :formatters, formatters)
   end
 
+  defp update_output_for_formatter(options, formatter) do
+    output = options[:output] || "doc"
+    formatter_output = Path.join(output, formatter)
+    Keyword.put(options, :output, formatter_output)
+  end
+
   defp get_docs_opts(config) do
     docs = config[:docs]
 

test/ex_doc/formatter/html_test.exs

@@ -967,7 +967,7 @@ defmodule ExDoc.Formatter.HTMLTest do
       generate_docs(config)
 
       # Verify necessary files in .build
-      content = File.read!(tmp_dir <> "/html/.build/html/.build")
+      content = File.read!(tmp_dir <> "/html/.build")
       assert content =~ ~r(^readme\.html$)m
       assert content =~ ~r(^api-reference\.html$)m
       assert content =~ ~r(^dist/sidebar_items-[\w]{8}\.js$)m
@@ -995,7 +995,7 @@ defmodule ExDoc.Formatter.HTMLTest do
       File.touch!(keep)
       generate_docs(config)
       assert File.exists?(keep)
-      content = File.read!(tmp_dir <> "/html/.build/html/.build")
+      content = File.read!(tmp_dir <> "/html/.build")
       refute content =~ ~r{keep}
     end
   end