Merge pull request #2518 from dotty-staging/topic/dottydoc-scaladays-2k17-3

[scaladays] dottydoc fixups 3

Author: felixmulder

doc-tool/resources/_includes/toolbar.html

@@ -3,7 +3,7 @@
         {% include "scala-logo.svg" %}
     </a>
     <div id="project-details">
-        <h1 id="project-name">{{ site.project }} Documentation</h1>
+        <h1 id="project-name"><a href="{{ site.baseurl }}/docs/">{{ site.project }} Documentation</a></h1>
         <h2 id="project-version">{{ site.version }}</h2>
     </div>
 

doc-tool/resources/_layouts/doc-page.html

@@ -13,6 +13,9 @@
     {% include "sidebar" %}
 
     <div id="content-body" class="doc-page-body">
+        <a id="edit-on-github" href="{{ site.projectUrl }}/edit/master/{{ site.root }}/{{ page.url }}">
+            Edit this page on GitHub
+        </a>
         <h1 id="doc-page-title">{{ page.title }}</h1>
         <hr/>
         <div id="doc-page-container">

doc-tool/resources/_layouts/search.html

@@ -147,14 +147,18 @@ <h1>Member Results</h1>
             var paramLists = !member.paramLists ? "" : (
                 member.paramLists
                     .map(renderParamList)
-                    .reduce(concatenateStrings, "")
+                    .reduce(concatenateStrings, "") + ': '
+            );
+
+            var returnValue = !member.returnValue ? "" : (
+                member.returnValue
             );
 
             div.innerHTML =
                 '<div class="member-kind">'+ member.kind +'</div>' +
                 '<div class="member-name">'+ member.name +'</div>' +
-                '<div class="member-param-lists">' + paramLists + ':</div>' +
-                '<div class="member-return">'+ member.returnValue +'</div>'
+                '<div class="member-param-lists">' + paramLists + '</div>' +
+                '<div class="member-return">'+ returnValue +'</div>'
 
             li.appendChild(div);
         };

doc-tool/resources/css/dottydoc.css

@@ -1,4 +1,5 @@
 @import url(https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,300,400,600,700);
+@import url(https://fonts.googleapis.com/css?family=Titillium+Web:200,300,400,600);
 @import url(https://fonts.googleapis.com/css?family=Roboto+Slab:100,300,400,700);
 
 html, body {
@@ -34,6 +35,24 @@ div#content-wrapper div#content-body {
             transition: all .25s ease-out;
 }
 
+div#content-body > a#edit-on-github {
+    border-left: 1px solid #fff;
+    position: absolute;
+    top: 47px;
+    padding-left: 10px;
+    right: 250px;
+    font-size: 14px;
+    color: #373a3c;
+    font-family: "Titillium Web", sans-serif;
+    text-transform: uppercase;
+}
+
+div#content-body > a#edit-on-github:hover,
+div#content-body > a#edit-on-github:focus {
+    text-decoration: none;
+    border-left: 1px solid #0fa00f;
+}
+
 div#content-wrapper button#menu-toggle {
     background: rgba(244, 243, 244, 0.4) none;
     border: 1px solid transparent;

doc-tool/resources/css/search.css

@@ -127,14 +127,27 @@ div.results li.entity-result-li:hover {
 }
 
 div.results li.entity-result-li > div.member-result {
+    overflow: hidden;
     padding-top: 3px;
     display: block;
-    width: 100%;
-    min-height: 30px;
+    width: calc(100% - 105px);
+    margin-bottom: 10px;
     transition: all 0.2s ease;
     margin-left: 105px;
 }
 
+div.results li.entity-result-li:hover > div.member-result {
+    width: calc(100% - 65px);
+}
+
+div.results li.entity-result-li.with-companion:hover > div.member-result {
+    width: calc(100% - 23px);
+}
+
+div.results li.entity-result-li:not(.with-companion) > div.member-result {
+    margin-left: 65px;
+}
+
 div.results li.entity-result-li:hover > div.member-result {
     margin-left: 23px;
 }
@@ -144,8 +157,11 @@ div.results li.entity-result-li > div.member-result > div.member-kind {
     font-weight: 400;
 }
 
+div.results li.entity-result-li > div.member-result > div.member-param-lists {
+    margin-right: 5px;
+}
+
 div.results li.entity-result-li > div.member-result > div.member-return {
-    margin-left: 5px;
     font-weight: 400;
     white-space: nowrap;
 }

doc-tool/resources/css/toolbar.css

@@ -48,21 +48,31 @@ div#toolbar > div#project-details:before {
 }
 
 div#toolbar > div#project-details > h1#project-name {
-  font-size: 20px;
-  font-weight: 300;
-  margin-bottom: 3px;
+    font-size: 20px;
+    font-weight: 300;
+    margin-bottom: 3px;
+}
+
+div#toolbar > div#project-details > h1#project-name > a {
+    color: #fff;
+}
+
+div#toolbar > div#project-details > h1#project-name > a:hover,
+div#toolbar > div#project-details > h1#project-name > a:focus {
+    text-decoration: none;
+    color: rgba(255, 255, 255, 0.8);
 }
 
 div#toolbar > div#project-details > h2#project-version {
-  font-size: 12px;
-  font-weight: 200;
-  margin-left: 1px;
+    font-size: 12px;
+    font-weight: 200;
+    margin-left: 1px;
 }
 
 div#toolbar > a#github-link {
-  color: #fff;
-  position: absolute;
-  top: 7px;
-  right: 15px;
-  font-size: 40px;
+    color: #fff;
+    position: absolute;
+    top: 7px;
+    right: 15px;
+    font-size: 40px;
 }

doc-tool/src/dotty/tools/dottydoc/model/references.scala

@@ -51,7 +51,7 @@ object references {
         if (args.isEmpty)
           "() => " + ret.showReference
         else if (args.tail.isEmpty)
-          args.head + " => " + ret.showReference
+          args.head.showReference + " => " + ret.showReference
         else
           args.mkString("(", ",", s") => ${ret.showReference}")
 

doc-tool/src/dotty/tools/dottydoc/staticsite/DefaultParams.scala

@@ -39,7 +39,8 @@ case class DefaultParams(
         "posts" -> site.posts.map(_.toMap),
         "project" -> site.projectTitle,
         "version" -> site.projectVersion,
-        "projectUrl" -> site.projectUrl
+        "projectUrl" -> site.projectUrl,
+        "root" -> site.root
       ).asJava,
 
       "sidebar" -> sidebar.titles.asJava
@@ -55,7 +56,7 @@ case class DefaultParams(
 
   def withPosts(posts: Array[BlogPost]): DefaultParams =
     copy(site = SiteInfo(
-      site.baseurl, site.projectTitle, site.projectVersion, site.projectUrl, posts))
+      site.baseurl, site.projectTitle, site.projectVersion, site.projectUrl, posts, site.root))
 
   def withUrl(url: String): DefaultParams =
     copy(page = PageInfo(url))
@@ -74,7 +75,8 @@ case class SiteInfo(
   projectTitle: String,
   projectVersion: String,
   projectUrl: String,
-  posts: Array[BlogPost]
+  posts: Array[BlogPost],
+  root: String
 )
 
 case class Sidebar(titles: List[Title])

doc-tool/src/dotty/tools/dottydoc/staticsite/Site.scala

@@ -172,7 +172,10 @@ case class Site(
 
     DefaultParams(
       docs, docsFlattened, documentation, PageInfo(pathFromRoot),
-      SiteInfo(baseUrl, projectTitle, projectVersion, projectUrl, Array()),
+      SiteInfo(
+        baseUrl, projectTitle, projectVersion, projectUrl, Array(),
+        root.toString
+      ),
       sidebar
     )
   }
@@ -290,7 +293,7 @@ case class Site(
     * // given that root is: /some/root
     * ```
     */
-  def stripRoot(f: JFile): String = {
+  def stripRoot(f: JFile, root: JFile = root): String = {
     val rootLen = root.getAbsolutePath.length + 1
     f.getAbsolutePath.drop(rootLen)
   }

doc-tool/test/dotty/tools/dottydoc/staticsite/SiteTests.scala

@@ -78,8 +78,8 @@ class SiteTests extends DottyDocTest with SourceFileOps {
   }
 
   @Test def siteStructure = {
-    val assets = site.staticAssets.map(site.stripRoot).toSet
-    val compd  = site.compilableFiles.map(site.stripRoot).toSet
+    val assets = site.staticAssets.map(site.stripRoot(_)).toSet
+    val compd  = site.compilableFiles.map(site.stripRoot(_)).toSet
 
     val expectedAssets = Set(
       "css/toolbar.css",

docs/sidebar.yml

@@ -1,8 +1,6 @@
 sidebar:
     - title: Blog
       url: blog/index.html
-    - title: Docs
-      url: docs/index.html
     - title: Usage
       subsection:
         - title: cbt-projects
@@ -54,4 +52,4 @@ sidebar:
     - title: Resources
       subsection:
         - title: Talks
-          url: docs/resources/talks.html
+          url: docs/resources/talks.html