[DOC] Removes "documentation" page and adds Other version in nav bar (scikit-learn#15121)

thomasjpfan · NicolasHug · commit 7d35f4fc3cbb · 2019-10-14T08:24:41.000-04:00
diff --git a/build_tools/circle/list_versions.py b/build_tools/circle/list_versions.py
@@ -49,7 +49,7 @@ def get_pdf_size(version):
 print()
 
 ROOT_URL = 'https://api.github.com/repos/scikit-learn/scikit-learn.github.io/contents/'  # noqa
-RAW_FMT = 'https://raw.githubusercontent.com/scikit-learn/scikit-learn.github.io/master/%s/documentation.html'  # noqa
+RAW_FMT = 'https://raw.githubusercontent.com/scikit-learn/scikit-learn.github.io/master/%s/index.html'  # noqa
 VERSION_RE = re.compile(r"scikit-learn ([\w\.\-]+) documentation</title>")
 NAMED_DIRS = ['dev', 'stable']
 
@@ -88,8 +88,8 @@ def get_pdf_size(version):
     else:
         seen.add(version_num)
     name_display = '' if name[:1].isdigit() else ' (%s)' % name
-    path = 'http://scikit-learn.org/%s' % name
-    out = ('* `Scikit-learn %s%s documentation <%s/documentation.html>`_'
+    path = 'https://scikit-learn.org/%s/' % name
+    out = ('* `Scikit-learn %s%s documentation <%s>`_'
            % (version_num, name_display, path))
     if pdf_size is not None:
         out += (' (`PDF %s <%s/_downloads/scikit-learn-docs.pdf>`_)'
diff --git a/doc/conf.py b/doc/conf.py
@@ -171,8 +171,7 @@
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-html_additional_pages = {'index': 'index.html',
-                         'documentation': 'documentation.html'}
+html_additional_pages = {'index': 'index.html'}
 
 # If false, no module index is generated.
 html_domain_indices = False
diff --git a/doc/templates/documentation.html b/doc/templates/documentation.html
diff --git a/doc/templates/index.html b/doc/templates/index.html
@@ -9,7 +9,7 @@ <h1 class="sk-landing-header text-white text-monospace">scikit-learn</h1>
         <h4 class="sk-landing-subheader text-white font-italic mb-3">Machine Learning in Python</h4>
         <a class="btn sk-landing-btn mb-1" href="{{ pathto('getting_started') }}" role="button">Getting Started</a>
         <a class="btn sk-landing-btn mb-1" href="whats_new.html" role="button">Whats New in {{ version }}</a>
-        <a class="btn sk-landing-btn mb-1" href="{{ pathto('documentation') }}" role="button">Documentation</a>
+        <a class="btn sk-landing-btn mb-1" href="https://github.com/scikit-learn/scikit-learn" role="button">GitHub</a>
       </div>
       <div class="col-md-6 d-flex">
         <ul class="sk-landing-header-body">
diff --git a/doc/themes/scikit-learn-modern/nav.html b/doc/themes/scikit-learn-modern/nav.html
@@ -7,15 +7,16 @@
 {%- endif %}
 
 {%- set drop_down_navigation = [
-  ('Getting Started', 'getting_started'),
-  ('Tutorial', 'tutorial/index'),
-  ('Glossary', 'glossary'),
-  ('Development', 'developers/index'),
-  ('FAQ', 'faq'),
-  ('Related packages', 'related_projects'),
-  ('Roadmap', 'roadmap'),
-  ('About us', 'about'),
-  ('Documentation', 'documentation')]
+  ('Getting Started', pathto('getting_started')),
+  ('Tutorial', pathto('tutorial/index')),
+  ('Glossary', pathto('glossary')),
+  ('Development', pathto('developers/index')),
+  ('FAQ', pathto('faq')),
+  ('Related packages', pathto('related_projects')),
+  ('Roadmap', pathto('roadmap')),
+  ('About us', pathto('about')),
+  ('GitHub', 'https://github.com/scikit-learn/scikit-learn'),
+  ('Other Versions', 'https://scikit-learn.org/dev/versions.html')]
 -%}
 
 <nav id="navbar" class="{{ nav_bar_class }} navbar navbar-expand-md navbar-light bg-light py-0">
@@ -57,14 +58,14 @@
         </li>
         {%- for title, link in drop_down_navigation %}
         <li class="nav-item">
-          <a class="sk-nav-link nav-link nav-more-item-mobile-items" href="{{ pathto(link) }}">{{ title }}</a>
+          <a class="sk-nav-link nav-link nav-more-item-mobile-items" href="{{ link }}">{{ title }}</a>
         </li>
         {%- endfor %}
         <li class="nav-item dropdown nav-more-item-dropdown">
           <a class="sk-nav-link nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">More</a>
           <div class="dropdown-menu" aria-labelledby="navbarDropdown">
             {%- for title, link in drop_down_navigation %}
-              <a class="sk-nav-dropdown-item dropdown-item" href="{{ pathto(link) }}">{{ title}}</a>
+              <a class="sk-nav-dropdown-item dropdown-item" href="{{ link }}">{{ title}}</a>
             {%- endfor %}
           </div>
         </li>
