From 8bd9c4449c87f5dd8dc076afd38a63e59c349463 Mon Sep 17 00:00:00 2001
From: Alexander Graf <mail@agraf.me>
Date: Fri, 6 Apr 2018 19:24:43 +0200
Subject: [PATCH] Theme-related Documentation Enhancements

- Consistent background color in all types of codes
- Improve dd (list item) padding
- Link to Index in global TOC in navbar
- Briefly describe Instaloader in `index.html` title
- Remove page contents (navbartoc) in index, genindex and installation
- Link to new pypi.org rather than old pypi.python.org
---
 docs/_static/style.css         | 11 ++++++++++-
 docs/_templates/globaltoc.html | 14 ++++++++++++++
 docs/_templates/layout.html    |  7 +++++++
 docs/_templates/navbar.html    |  6 +++---
 docs/conf.py                   |  2 +-
 docs/index.rst                 |  8 +++++---
 6 files changed, 40 insertions(+), 8 deletions(-)
 create mode 100644 docs/_templates/globaltoc.html

diff --git a/docs/_static/style.css b/docs/_static/style.css
index f34d322..c603332 100644
--- a/docs/_static/style.css
+++ b/docs/_static/style.css
@@ -1,3 +1,12 @@
 code {
     color: #222;
-}
\ No newline at end of file
+    background-color: #f5f5f5;
+}
+
+dd {
+    padding-left: 8px;
+}
+
+dl.option dd {
+    padding-left: 12px;
+}
diff --git a/docs/_templates/globaltoc.html b/docs/_templates/globaltoc.html
new file mode 100644
index 0000000..a832919
--- /dev/null
+++ b/docs/_templates/globaltoc.html
@@ -0,0 +1,14 @@
+<li class="dropdown globaltoc-container">
+  <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) }}
+    <li role="separator" class="divider"></li>
+    <li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
+  </ul>
+</li>
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
index e722476..9dcc05b 100644
--- a/docs/_templates/layout.html
+++ b/docs/_templates/layout.html
@@ -1,4 +1,11 @@
 {% extends "!layout.html" %}
+{% block htmltitle %}
+  {% if pagename == "index" %}
+  <title>{{ title|striptags|e }}</title>
+  {% else %}
+  <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
+  {% endif %}
+{% endblock %}
 {% block extrahead %}
 {{ super() }}
   <meta name="google-site-verification" content="FNUsDdkOJM9obm9QEdrNBVd9AtAzHzA-aaSMCUrS6C8" />
diff --git a/docs/_templates/navbar.html b/docs/_templates/navbar.html
index ecb9852..382d0c7 100644
--- a/docs/_templates/navbar.html
+++ b/docs/_templates/navbar.html
@@ -14,7 +14,7 @@
           {% if theme_navbar_title -%}{{ theme_navbar_title|e }}{%- else -%}{{ project|e }}{%- endif -%}
         </a>
         <span class="navbar-text navbar-version pull-left">
-          <a href="https://github.com/instaloader/instaloader/releases/tag/v{{current_release}}" title="Released on {{current_release_date}}.">v<b>{{current_release}}</b></a>
+          <a href="https://github.com/instaloader/instaloader/releases/tag/v{{current_release}}" title="Released on {{current_release_date}}">v<b>{{current_release}}</b></a>
         </span>
       </div>
 
@@ -27,7 +27,7 @@
             {% endif %}
             {% block navbartoc %}
               {% include "globaltoc.html" %}
-              {% if theme_navbar_pagenav %}
+              {% if theme_navbar_pagenav and pagename not in ("index", "genindex", "installation") %}
                 {% include "navbartoc.html" %}
               {% endif %}
             {% endblock %}
@@ -46,7 +46,7 @@
                 <ul class="dropdown-menu" role="menu" aria-labelledby="dLabelUsefulLinks">
                   <li><a href="https://github.com/instaloader/instaloader/issues">Issue Tracker</a></li>
                   <li><a href="https://github.com/instaloader/instaloader/releases">Version History</a></li>
-                  <li><a href="https://pypi.python.org/pypi/instaloader">Instaloader on PyPI</a></li>
+                  <li><a href="https://pypi.org/project/instaloader/">Instaloader on PyPI</a></li>
                   <li><a href="https://github.com/instaloader/instaloader">Instaloader on GitHub</a></li>
                   <li role="separator" class="divider"></li>
                   <li style="padding-left: 20px;"><a class="github-button" href="https://github.com/instaloader/instaloader" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star Instaloader on GitHub">Star</a></li>
diff --git a/docs/conf.py b/docs/conf.py
index 2fbd999..850430a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -212,7 +212,7 @@ html_domain_indices = False
 
 # If false, no index is generated.
 #
-html_use_index = False
+html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
 #
diff --git a/docs/index.rst b/docs/index.rst
index e18ac7e..98821bb 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -5,6 +5,8 @@
       saved media, and their metadata, comments and captions.
       Written in Python.
 
+.. title:: Instaloader — Download Instagram Photos and Metadata
+
 Instaloader
 ===========
 
@@ -43,8 +45,8 @@ With `Python <https://www.python.org/>`__ installed, do::
                 :stories | :feed | :saved
 
 
-Table of Contents
------------------
+Instaloader Documentation
+-------------------------
 
 .. toctree::
    :maxdepth: 2
@@ -59,7 +61,7 @@ Useful Links
 ------------
 
 - `Git Repository (on GitHub) <https://github.com/instaloader/instaloader>`__
-- `PyPI Project Page <https://pypi.python.org/pypi/instaloader>`__
+- `PyPI Project Page <https://pypi.org/project/instaloader/>`__
 - `Issue Tracker / Bug Tracker <https://github.com/instaloader/instaloader/issues>`__
 - `Version History <https://github.com/instaloader/instaloader/releases>`__