File ex_doc-0.13.0-git.patch of Package ex_doc

Overview Repositories Revisions Requests Users Attributes Meta

File ex_doc-0.13.0-git.patch of Package ex_doc (Revision ca29bc41b103260bae12a6c840f5bfed)

Currently displaying revision ca29bc41b103260bae12a6c840f5bfed , Show latest

diff --git a/assets/js/templates/search-results.handlebars b/assets/js/templates/search-results.handlebars
index 9f96bbf..35506f5 100644
--- a/assets/js/templates/search-results.handlebars
+++ b/assets/js/templates/search-results.handlebars
@@ -30,7 +30,7 @@
           </ul>
           <ul class="callbacks">
             {{#each callbacks}}
-              <li class="result-elem"><a href="{{../id}}.html#{{{anchor}}}">{{{match}}}</a></li>
+              <li class="result-elem"><a href="{{../id}}.html#{{{anchor}}}">{{{match}}}</a> (callback)</li>
             {{/each}}
           </ul>
         </div>
diff --git a/assets/less/content/code.less b/assets/less/content/code.less
index 6d4d232..015b562 100644
--- a/assets/less/content/code.less
+++ b/assets/less/content/code.less
@@ -32,6 +32,7 @@ code {
 
 pre {
   margin: @baseLineHeight 0;
+  overflow-x: scroll;
 
   &.spec {
       margin: 0;
@@ -46,4 +47,4 @@ pre {
     padding: 1em 1.5em;
     background-color: @lightestBlue;
   }
-}
\ No newline at end of file
+}
diff --git a/assets/less/content/functions.less b/assets/less/content/functions.less
index bdf931f..39367f1 100644
--- a/assets/less/content/functions.less
+++ b/assets/less/content/functions.less
@@ -13,7 +13,7 @@
 
   .signature {
     font-size: 1rem;
-    font-weight: 600;
+    font-weight: 700;
   }
 
   &:hover a.detail-link {
@@ -59,7 +59,7 @@
   h3,
   h4,
   h5 {
-    font-weight: 800;
+    font-weight: 700;
   }
 
   h2 {
diff --git a/assets/less/content/general.less b/assets/less/content/general.less
index 6e140e7..f49cb37 100644
--- a/assets/less/content/general.less
+++ b/assets/less/content/general.less
@@ -6,7 +6,7 @@ h4,
 h5,
 h6 {
   font-family: @sansFontFamily;
-  font-weight: 800;
+  font-weight: 700;
   line-height: 1.5em;
   word-wrap: break-word;
 }
@@ -31,14 +31,13 @@ h1 {
 h2 {
   font-size: 1.625em;
   margin: 1em 0 .5em;
-  font-weight: 400;
+  font-weight: 700;
 }
 
 h3 {
   font-size: 1.375em;
-  font-weight: 400;
   margin: 1em 0 .5em;
-  font-weight: 600;
+  font-weight: 700;
 }
 
 a {
@@ -109,7 +108,7 @@ th {
   text-align: left;
   font-family: @sansFontFamily;
   text-transform: uppercase;
-  font-weight: 600;
+  font-weight: 700;
   padding-bottom: .5em;
 }
 
diff --git a/assets/less/content/summary.less b/assets/less/content/summary.less
index 5acac4b..dd33027 100644
--- a/assets/less/content/summary.less
+++ b/assets/less/content/summary.less
@@ -1,6 +1,6 @@
 .summary {
   h2 {
-    font-weight: 600;
+    font-weight: 700;
 
     a {
         background: none;
@@ -12,7 +12,7 @@
   .summary-row {
     .summary-signature {
       font-family: @monoFontFamily;
-      font-weight: 600;
+      font-weight: 700;
 
       a {
         background: none;
diff --git a/assets/less/fonts.css b/assets/less/fonts.css
index 13f1bcb..2ea5aa9 100644
--- a/assets/less/fonts.css
+++ b/assets/less/fonts.css
@@ -1 +1 @@
-@import url('https://fonts.googleapis.com/css?family=Lato:400,300,700,900|Merriweather:300italic,300,700,700italic|Inconsolata:400,700');
+@import url('https://fonts.googleapis.com/css?family=Lato:300,700|Merriweather:300italic,300|Inconsolata:400,700');
diff --git a/assets/less/toggle.less b/assets/less/toggle.less
index eac0963..3a04fae 100644
--- a/assets/less/toggle.less
+++ b/assets/less/toggle.less
@@ -36,7 +36,7 @@
   .sidebar-opened {
     .sidebar-toggle {
       left: 18px;
-      top: 8px;
+      top: 5px;
     }
   }
 }
diff --git a/lib/ex_doc/formatter/html/autolink.ex b/lib/ex_doc/formatter/html/autolink.ex
index e82e175..39e7a09 100644
--- a/lib/ex_doc/formatter/html/autolink.ex
+++ b/lib/ex_doc/formatter/html/autolink.ex
@@ -28,7 +28,8 @@ defmodule ExDoc.Formatter.HTML.Autolink do
   end
 
   defp all_docs(module, modules) do
-    locals = Enum.map module.docs, &(doc_prefix(&1) <> &1.id)
+    locals = Enum.map(module.docs, &(doc_prefix(&1) <> &1.id)) ++
+      Enum.map(module.typespecs, &("t:" <> &1.id))
 
     moduledoc =
       if module.moduledoc do
@@ -202,7 +203,8 @@ defmodule ExDoc.Formatter.HTML.Autolink do
   will get translated to the new href of the function.
   """
   def local_doc(bin, locals) when is_binary(bin) do
-    ~r{(?<!\[)`\s*(([a-z\d_!\\?>\\|=&<!~+\\.\\+*^@-]+)/\d+)\s*`(?!\])}
+    fun_re = ~r{(([ct]:)?([a-z\d_!\\?>\\|=&<!~+\\.\\+*^@-]+)/\d+)} |> Regex.source
+    ~r{(?<!\[)`\s*(#{fun_re})\s*`(?!\])}
     |> Regex.scan(bin)
     |> Enum.uniq()
     |> List.flatten()
@@ -220,6 +222,9 @@ defmodule ExDoc.Formatter.HTML.Autolink do
   """
   def project_doc(bin, modules, module_id \\ nil) when is_binary(bin) do
     project_funs = for m <- modules, d <- m.docs, do: doc_prefix(d) <> m.id <> "." <> d.id
+    project_types = for m <- modules, d <- m.typespecs, do: "t:" <> m.id <> "." <> d.id
+    project_funs = project_funs ++ project_types
+
     project_modules =
       modules
       |> Enum.map(&module_to_string/1)
@@ -243,7 +248,9 @@ defmodule ExDoc.Formatter.HTML.Autolink do
   will get translated to the new href of the function.
   """
   def project_functions(bin, project_funs) when is_binary(bin) do
-    ~r{(?<!\[)`\s*((c:)?(([A-Z][A-Za-z]+)\.)+([a-z_!\?>\|=&<!~+\.\+*^@-]+)/\d+)\s*`(?!\])}
+    module_re = ~r{(([A-Z][A-Za-z_\d]+)\.)+} |> Regex.source
+    fun_re = ~r{([ct]:)?(#{module_re}([a-z\d_!\\?>\\|=&<!~+\\.\\+*^@-]+)/\d+)} |> Regex.source
+    ~r{(?<!\[)`\s*(#{fun_re})\s*`(?!\])}
     |> Regex.scan(bin)
     |> Enum.uniq()
     |> List.flatten()
@@ -266,7 +273,7 @@ defmodule ExDoc.Formatter.HTML.Autolink do
   will get translated to the new href of the module.
   """
   def project_modules(bin, modules, module_id \\ nil) when is_binary(bin) do
-    ~r{(?<!\[)`\s*(([A-Z][A-Za-z]+\.?)+)\s*`(?!\])}
+    ~r{(?<!\[)`\s*(([A-Z][A-Za-z_\d]+\.?)+)\s*`(?!\])}
     |> Regex.scan(bin)
     |> Enum.uniq()
     |> List.flatten()
@@ -288,6 +295,11 @@ defmodule ExDoc.Formatter.HTML.Autolink do
     {"", mod, fun, arity} = split_function(bin)
     {"c:", mod, fun, arity}
   end
+  defp split_function("t:" <> bin) do
+    {"", mod, fun, arity} = split_function(bin)
+    {"t:", mod, fun, arity}
+  end
+
 
   defp split_function(bin) do
     [modules, arity] = String.split(bin, "/")
diff --git a/lib/ex_doc/formatter/html/templates/module_template.eex b/lib/ex_doc/formatter/html/templates/module_template.eex
index db99eb2..45aad1f 100644
--- a/lib/ex_doc/formatter/html/templates/module_template.eex
+++ b/lib/ex_doc/formatter/html/templates/module_template.eex
@@ -15,7 +15,7 @@
       </h1>
 
       <%= if module.moduledoc do %>
-        <section id="moduledoc" class="docstring">
+        <section id="moduledoc">
           <%= module.moduledoc |> to_html() |> link_moduledoc_headings() %>
         </section>
       <% end %>
diff --git a/test/ex_doc/formatter/html/autolink_test.exs b/test/ex_doc/formatter/html/autolink_test.exs
index ec0a35c..8603a90 100644
--- a/test/ex_doc/formatter/html/autolink_test.exs
+++ b/test/ex_doc/formatter/html/autolink_test.exs
@@ -18,6 +18,19 @@ defmodule ExDoc.Formatter.HTML.AutolinkTest do
       "[`funny_name\?/1`](#funny_name\?/1) and [`funny_name!/2`](#funny_name!/2)"
   end
 
+  test "autolink to local callbacks" do
+    # `split_function` must also return locally defined callbacks
+    # format should be: "c:<fun>/<arity>"
+    assert Autolink.local_doc("`c:fun/2`", ["c:fun/2"]) == "[`fun/2`](#c:fun/2)"
+  end
+
+  test "autolink to local types" do
+    assert Autolink.local_doc("`t:my_type/0`", ["t:my_type/0"]) == "[`my_type/0`](#t:my_type/0)"
+    assert Autolink.local_doc("`t:my_type/1`", ["t:my_type/1"]) == "[`my_type/1`](#t:my_type/1)"
+    # links to types without arity don't work
+    assert Autolink.local_doc("`t:my_type`", ["t:my_type/0"]) == "`t:my_type`"
+  end
+
   test "autolink doesn't create links for undefined functions in docs" do
     assert Autolink.local_doc("`example/1`", ["example/2"]) == "`example/1`"
     assert Autolink.local_doc("`example/1`", []) == "`example/1`"
@@ -103,6 +116,14 @@ defmodule ExDoc.Formatter.HTML.AutolinkTest do
     assert Autolink.project_modules("`MyModule.Nested`", ["MyModule.DiffNested"]) == "`MyModule.Nested`"
   end
 
+  test "autolink to types in the project" do
+    # use the same approach for project_functions as for local_docs
+    assert Autolink.project_functions("`t:MyModule.my_type/0`",
+      ["t:MyModule.my_type/0"]) ==  "[`MyModule.my_type/0`](MyModule.html#t:my_type/0)"
+      assert Autolink.project_functions("`t:MyModule.my_type`",
+        ["t:MyModule.my_type/0"]) ==  "`t:MyModule.my_type`"
+  end
+
   # erlang functions
 
   @erlang_docs "http://www.erlang.org/doc/man/"

Places

File ex_doc-0.13.0-git.patch of Package ex_doc (Revision ca29bc41b103260bae12a6c840f5bfed)

Places