Unified external+local links + multiple dropdowns

Author: JeanKossaifi

README.rst

@@ -46,9 +46,8 @@ The options are:
 
 * `'google_analytics'` : str, your Google analytics ID, if any.
 * `'nav_links'` :  tuple list, a list of ('Link display name', 'local.file'), contains the links to the local documentation, in the top navigation bar.
-* `'external_nav_links'` : same as above but contains external links.
-* `'external_nav_links_dropdown'` : same as above but contains multiple links in a dropdown. 
-   In that case, `'external_nav_links_dropdown_title'` indicates the text of the dropdown button.
+                   if the link starts with 'http', it will be considered as an external link.
+* `'nav_dropdowns'` : same as above but contains multiple links in a dropdown. 
 
 
 **Example:**
@@ -58,13 +57,13 @@ The options are:
     html_theme_options = {
         'google_analytics' : 'YOUR_GOOGLE_ANALYTICS_ID',
         'nav_links' : [('Install', 'installation'), 
-                    ('User Guide', 'user_guide/index')]
-        'external_nav_links' : [('TensorLy', 'https://github.com/tensorly/tensorly'),
-                                ('TensorLy-Torch', 'https://github.com/tensorly/torch')],
-        'external_nav_links_dropdown_title': 'LinksInDropdown',
-        'external_nav_links_dropdown' : [('TensorLy', 'http://tensorly.org/dev'),
-                                         ('TensorLy-Viz', 'http://tensorly.org/viz'),
-                                         ('TensorLy-Quantum', 'http://tensorly.org/quantum')],
+                       ('User Guide', 'user_guide/index'),
+                       ('TensorLy', 'https://github.com/tensorly/tensorly'),
+                       ('TensorLy-Torch', 'https://github.com/tensorly/torch')],
+        'nav_dropdowns': [('LinksInDropdown', [('TensorLy', 'http://tensorly.org/dev'),
+                                               ('TensorLy-Viz', 'http://tensorly.org/viz'),
+                                               ('TensorLy-Quantum', 'http://tensorly.org/quantum')]
+                          )],
 }
 
 

tensorly_sphinx_theme/navigation.html

@@ -33,28 +33,33 @@
             {# RIGHT  #}
 
             {%- for (name, link) in theme_nav_links %}
-            <a class="navbar-item" href="{{pathto(link)}}">
+              {%- if link.startswith('http') %}
+              <a class="navbar-item" href="{{link}}" target="_blank">
+              {%- else %}
+              <a class="navbar-item" href="{{pathto(link)}}">
+              {%- endif %}
               {{name}}
             </a>
             {%- endfor %}
-            {%- for (name, link) in theme_external_nav_links %}
-            <a class="navbar-item" href="{{link}}" target="_blank">
-              {{name}}
-            </a>
-            {%- endfor %}
-            {%- if theme_external_nav_links_dropdown_title %}
+            {%- if theme_nav_dropdowns %}
+            {%- for (dropdown_title, dropdown_links) in theme_nav_dropdowns %}
             <div class="navbar-item has-dropdown is-hoverable is-boxed">
               <a class="navbar-link">
-                {{theme_external_nav_links_dropdown_title}}
+                {{dropdown_title}}
               </a>
               <div class="navbar-dropdown top-navbar">
-                {%- for (name, link) in theme_external_nav_links_dropdown %}
+              {%- for (name, link) in dropdown_links %}
+                {%- if link.startswith('http') %}
                 <a class="navbar-item" href="{{link}}" target="_blank">
+                {%- else %}
+                <a class="navbar-item" href="{{pathto(link)}}" target="_blank">
+                {%- endif %}
                   {{name}}
                 </a>
-                {%- endfor %}
+              {%- endfor %}
               </div>
             </div>
+            {%- endfor %}
             {%- endif %}
           </div>
 

tensorly_sphinx_theme/theme.conf

@@ -11,7 +11,5 @@ globaltoc_maxdepth = 2
 github_url = 
 google_analytics = 
 nav_links = 
-external_nav_links =
-external_nav_links_dropdown_title = 
-external_nav_links_dropdown = 
+nav_dropdowns = 
 searchbar_text = Search the doc