WIP: Frameless docs + New Menu

This is a Work in Process, there are a lot of things to fix at this
point:

 - [ ] Fix tests
 - [x] Review the changes made to the CSS styles
 - [x] Review the breadcrumbs
 - [x] Fix the possible conflict after #212 gets merged
 - [x] Fix the index.html to avoid the frameset.
 - [x] Improve the section below the `#sidebar` section in `module_template`
 - [x] Generate valid JSON for `sidebar_items.js`
 - [x] Improve CSS integration
 - [x] Remove frames
 - [x] Add an initial media query for `print` media
 - [x] Improve the JS style code and documentation
 - [x] Add meta tags `x-ua-compatible`, `viewport` and `generator`
 - [x] Delete `target` parameter from a element
 - [x] Add normalize.css
 - [x] Merge old full_list.css with style.css
 - [x] Add sidebar template
 - [x] Merge full_list.js into app.js
 - [x] Update jQuery v2.1.4

This effort will try to fix the issue #175

Author: milmazz

lib/ex_doc/formatter/html.ex

@@ -14,7 +14,6 @@ defmodule ExDoc.Formatter.HTML do
     File.rm_rf! output
     :ok = File.mkdir_p output
 
-    generate_index(output, config)
     generate_assets(output, config)
     has_readme = config.readme && generate_readme(output, modules, config)
 
@@ -23,22 +22,28 @@ defmodule ExDoc.Formatter.HTML do
     exceptions = filter_list(:exceptions, all)
     protocols  = filter_list(:protocols, all)
 
-    generate_overview(modules, exceptions, protocols, output, config)
-    generate_list(:modules, modules, all, output, config, has_readme)
-    generate_list(:exceptions, exceptions, all, output, config, has_readme)
-    generate_list(:protocols, protocols, all, output, config, has_readme)
+    generate_overview(modules, exceptions, protocols, output, config, has_readme)
+    generate_sidebar_items(modules, exceptions, protocols, output)
+    generate_list(modules, all, output, config, has_readme)
+    generate_list(exceptions, all, output, config, has_readme)
+    generate_list(protocols, all, output, config, has_readme)
 
     Path.join(config.output, "index.html")
   end
 
-  defp generate_index(output, config) do
-    content = Templates.index_template(config)
-    :ok = File.write("#{output}/index.html", content)
+  defp generate_overview(modules, exceptions, protocols, output, config, has_readme) do
+    content = Templates.overview_template(config, modules, exceptions, protocols, has_readme)
+
+    if has_readme do
+      :ok = File.write("#{output}/overview.html", content)
+    else
+      :ok = File.write("#{output}/index.html", content)
+    end
   end
 
-  defp generate_overview(modules, exceptions, protocols, output, config) do
-    content = Templates.overview_template(config, modules, exceptions, protocols)
-    :ok = File.write("#{output}/overview.html", content)
+  defp generate_sidebar_items(modules, exceptions, protocols, output) do
+    content = Templates.sidebar_items_template(modules, exceptions, protocols)
+    :ok = File.write("#{output}/sidebar_items.js", content)
   end
 
   defp assets do
@@ -66,7 +71,7 @@ defmodule ExDoc.Formatter.HTML do
   defp write_readme(output, {:ok, content}, modules, config) do
     content = Autolink.project_doc(content, modules)
     readme_html = Templates.readme_template(config, content) |> pretty_codeblocks
-    File.write("#{output}/README.html", readme_html)
+    File.write("#{output}/index.html", readme_html)
     true
   end
 
@@ -110,14 +115,12 @@ defmodule ExDoc.Formatter.HTML do
     Enum.filter nodes, &match?(%ExDoc.ModuleNode{type: x} when x in [:protocol], &1)
   end
 
-  defp generate_list(scope, nodes, all, output, config, has_readme) do
-    Enum.each nodes, &generate_module_page(&1, all, output, config)
-    content = Templates.list_page(scope, nodes, config, has_readme)
-    File.write("#{output}/#{scope}_list.html", content)
+  defp generate_list(nodes, all, output, config, has_readme) do
+    Enum.each nodes, &generate_module_page(&1, all, output, config, has_readme)
   end
 
-  defp generate_module_page(node, modules, output, config) do
-    content = Templates.module_page(node, config, modules)
+  defp generate_module_page(node, modules, output, config, has_readme) do
+    content = Templates.module_page(node, config, modules, has_readme)
     File.write("#{output}/#{node.id}.html", content)
   end
 

lib/ex_doc/formatter/html/templates.ex

@@ -8,19 +8,12 @@ defmodule ExDoc.Formatter.HTML.Templates do
   @doc """
   Generate content from the module template for a given `node`
   """
-  def module_page(node, config, all) do
+  def module_page(node, config, all, has_readme) do
     types       = node.typespecs
     functions   = Enum.filter node.docs, &match?(%ExDoc.FunctionNode{type: :def}, &1)
     macros      = Enum.filter node.docs, &match?(%ExDoc.FunctionNode{type: :defmacro}, &1)
     callbacks   = Enum.filter node.docs, &match?(%ExDoc.FunctionNode{type: :defcallback}, &1)
-    module_template(config, node, types, functions, macros, callbacks, all)
-  end
-
-  @doc """
-  Generates the listing.
-  """
-  def list_page(scope, nodes, config, has_readme) do
-    list_template(scope, nodes, config, has_readme)
+    module_template(config, node, types, functions, macros, callbacks, all, has_readme)
   end
 
   # Get the full specs from a function, already in HTML form.
@@ -109,12 +102,13 @@ defmodule ExDoc.Formatter.HTML.Templates do
   end
 
   templates = [
-    index_template: [:config],
-    list_template: [:scope, :nodes, :config, :has_readme],
-    overview_template: [:config, :modules, :exceptions, :protocols],
-    module_template: [:config, :module, :types, :functions, :macros, :callbacks, :all],
+    overview_template: [:config, :modules, :exceptions, :protocols, :has_readme],
+    sidebar_template: [:config, :has_readme],
+    sidebar_items_template: [:modules, :exceptions, :protocols],
+    sidebar_items_keys_template: [:node],
+    sidebar_items_entry_template: [:node],
+    module_template: [:config, :module, :types, :functions, :macros, :callbacks, :all, :has_readme],
     readme_template: [:config, :content],
-    list_item_template: [:node],
     overview_entry_template: [:node],
     summary_template: [:node],
     detail_template: [:node, :_module],