Merge pull request #2477 from dotty-staging/topic/dottydoc-scaladays-enhancements

Some enhancements for Dottydoc and ScalaDays

Author: felixmulder

CONTRIBUTING.md renamed to CONTRIBUTING

@@ -123,5 +123,12 @@ class ScalaSettings extends Settings.SettingGroup {
     sys.props("user.dir").split(File.separatorChar).last
   )
 
+  val projectVersion = StringSetting (
+    "-project-version",
+    "project version",
+    "The current version of your project",
+    ""
+  )
+
   val wikiSyntax = BooleanSetting("-Xwiki-syntax", "Retains the Scala2 behavior of using Wiki Syntax in Scaladoc")
 }

compiler/src/dotty/tools/dotc/config/ScalaSettings.scala

@@ -0,0 +1,38 @@
+<div class="index-wrapper" style="top: {{ sidebarTop }};">
+    <ul class="toc">
+        {% assign parent = page.path | first %}
+        {% for title in sidebar %}
+        <li>{% renderTitle title, parent %}</li>
+        {% endfor %}
+    </ul>
+
+    <ul class="index-entities">
+    {% if docs.size > 0 %}
+    <li class="index-title">
+        <span>API</span>
+    </li>
+    {% endif %}
+    {% for pkg in docs %}
+        <li class="index-entity entity-package">
+            <h1><a class="entity-name" href="{{ site.baseurl }}/api/{{ pkg.path | join: "/" }}/index.html">{{ pkg.name }}</a></h1>
+            <ul class="package-entities">
+                <div id="cover-block"></div>
+            {% for member in pkg.children %}
+                {% if member.kind == "object" and member.hasCompanion %}
+                {% elsif member.kind != "package" %}
+                <li class="{% if member.hasCompanion %} with-companion {% endif %}">
+                    <div class="entity-kinds">
+                        {% if member.hasCompanion %}
+                        <a class="letter-anchor object" href="{{ site.baseurl }}/api/{{ member.companionPath | join: "/" }}.html">O</a>
+                        {% endif %}
+                        <a class="letter-anchor {{ member.kind }}" href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}.html">{{ member.kind | first | capitalize }}</a>
+                    </div>
+                    <a class="entity-name" href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}.html">{{ member.name }}</a>
+                </li>
+                {% endif %}
+            {% endfor %}
+            </ul>
+        </li>
+    {% endfor %}
+    </ul>
+</div>

doc-tool/resources/_includes/scala-logo.svg

@@ -0,0 +1,9 @@
+<div id="toolbar">
+    <a id="home-button" href="{{ site.baseurl }}/index.html">
+        {% include "scala-logo.svg" %}
+    </a>
+    <div id="project-details">
+        <h1 id="project-name">{{ site.project }} Documentation</h1>
+        <h2 id="project-version">{{ site.version }}</h2>
+    </div>
+</div>