Merge pull request #10942 from IQSS/10941-remove-custom-guides-navbar

Guides: improve navigation

Author: ofahimIQSS

doc/release-notes/10941-remove-custom-guides-navbar.md

@@ -0,0 +1 @@
+Navigation across the guides has been improved. You can now click in the upper left to go "home". The navbar has been simplified with fewer links. The bottom of every page now has "Next" and "Previous" links. A "Source" link at the bottom has also been added. See #10942.

doc/sphinx-guides/source/_static/docsdataverse_org.css

@@ -35,6 +35,10 @@ iframe {
 
 a.navbar-brand, a.navbar-brand:hover {
     color:#C55B28 !important;
+    height: 50px;
+    background: rgba(0, 0, 0, 0) url("../_static/images/dataverseicon.png") no-repeat scroll 0 8px;
+    line-height: 20px;
+    padding-left: 26px;
 }
 span.navbar-brand {color:#C55B28 !important; padding-left: 32px; height: 50px;}
 span.navbar-brand .icon-dataverse {color:#C55B28; font-size:28px; margin: -4px 0 0 -27px; position: absolute;}
@@ -48,13 +52,6 @@ ul.navbar-nav li.dropdown.open > span.dropdown-toggle {background: #e7e7e7;}
 .text-dataset {color:#31708F;}
 .text-file {color:#777777;}
 
-#dataverse-org-homepage-url {
-    height: 50px;
-    background: rgba(0, 0, 0, 0) url("../_static/images/dataverseicon.png") no-repeat scroll 0 8px;
-    line-height: 20px;
-    padding-left: 26px;
-}
-
 .navbar-default .navbar-nav > li > a {
     color: #303030 !important;
 }
@@ -189,4 +186,4 @@ div.sphinx-tabs {
 
 li div.sphinx-tabs {
     padding-left: 0;
-}
+}

doc/sphinx-guides/source/_static/navbar_from_dataverse_org.js

@@ -144,7 +144,7 @@
     #     ("Link", "http://example.com", True),
     # ],
     'navbar_links': [
-        ("View 3.6.2 Guides", "http://docs.dataverse.org/en/3.6.2/", True),
+        ("About Dataverse", "https://dataverse.org", True),
     ],
 
     # Global TOC depth for "site" navbar tab. (Default: 1)

doc/sphinx-guides/source/_templates/navbar.html

@@ -1,9 +1,12 @@
 <li class="dropdown globaltoc-container">
+<!-- Comment out "Site" from navbar (we list guides in the sidebar anyway) -->
+<!--
   <a role="button"
      id="dLabelGlobalToc"
      data-toggle="dropdown"
      data-target="#"
      href="{{ pathto(master_doc) }}">{{ theme_navbar_site_name }} <b class="caret"></b></a>
+-->
   <ul class="dropdown-menu globaltoc"
       role="menu"
       aria-labelledby="dLabelGlobalToc">{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}</ul>

doc/sphinx-guides/source/conf.py

@@ -86,6 +86,22 @@
     {%- block sidebar1 %}{{ bsidebar() }}{% endblock %}
     <div class="{{ bs_span_prefix }}{{ bs_content_width }} content" role="main">
       {% block body %}{% endblock %}
+      <!-- Previous button -->
+      {%- if prev %}
+        <a href="{{ prev.link|e }}" title="{{ _('Previous Chapter: ') + prev.title|striptags }}">
+          {%- if theme_bootstrap_version == "2" -%}<span class="icon-chevron-left visible-tablet"></span>{%- endif -%}
+          {%- if theme_bootstrap_version == "3" -%}<span class="glyphicon glyphicon-chevron-left visible-sm"></span>{%- endif -%}
+          <span class="hidden-sm hidden-tablet">{{ "&laquo;Previous"|safe }}</span>
+        </a>
+      {%- endif %}
+      <!-- Next button -->
+      {%- if next %}
+        <a href="{{ next.link|e }}" title="{{ _('Next Chapter: ') + next.title|striptags }}" style="float: right;">
+          {%- if theme_bootstrap_version == "2" -%}<span class="icon-chevron-right visible-tablet"></span>{%- endif -%}
+          {%- if theme_bootstrap_version == "3" -%}<span class="glyphicon glyphicon-chevron-right visible-sm"></span>{%- endif -%}
+          <span class="hidden-sm hidden-tablet">{{ "Next&raquo"|safe }}</span>
+        </a>
+      {%- endif %}
     </div>
     {% block sidebar2 %} {# possible location for sidebar #} {% endblock %}
   </div>

doc/sphinx_bootstrap_theme/bootstrap/globaltoc.html

@@ -11,9 +11,9 @@
           {%- block sidebarlogo %}
             {%- if logo %}<span><img src="{{ pathto('_static/' + logo, 1) }}"></span>{%- endif %}
           {%- endblock %}
-          {% if theme_navbar_title -%}{{ theme_navbar_title|e }}{%- else -%}{{ project|e }}{%- endif -%}
+          {% if theme_navbar_title -%}{{ theme_navbar_title|e }}{%- else -%}Dataverse Guides{%- endif -%}
         </a>
-        <span class="navbar-text navbar-version pull-left"><b>{{ version|e }}</b></span>
+        <span class="navbar-text navbar-version pull-left"><b><a href="{{ pathto('versions') }}">v{{ version|e }}</a></b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -31,7 +31,10 @@
             {% endblock %}
             {% if theme_navbar_sidebarrel %}
               {% block sidebarrel %}
+                <!-- comment out "prev" and "next" buttons -->
+                <!--
                 {% include "relations.html" %}
+                -->
               {% endblock %}
             {% endif %}
             {% block navbarextra %}

doc/sphinx_bootstrap_theme/bootstrap/layout.html

@@ -1,9 +1,12 @@
 <li class="dropdown">
+<!-- Comment out "Page" from navbar (we put contents on every page anyway) -->
+<!--
   <a role="button"
      id="dLabelLocalToc"
      data-toggle="dropdown"
      data-target="#"
      href="#">{{ _(theme_navbar_pagenav_name) }} <b class="caret"></b></a>
+-->
   <ul class="dropdown-menu localtoc"
       role="menu"
       aria-labelledby="dLabelLocalToc">{{ toc }}</ul>

doc/sphinx_bootstrap_theme/bootstrap/navbar.html

@@ -48,7 +48,7 @@ navbar_fixed_top = true
 
 # Location of link to source.
 # Options are "nav" (default), "footer" or anything else to exclude.
-source_link_position = nav
+source_link_position = footer
 
 # Bootswatch (http://bootswatch.com/) theme.
 #