From ba868d681aac8273ad785ebf28f4a043b737ab78 Mon Sep 17 00:00:00 2001
From: David Lord <davidism@gmail.com>
Date: Mon, 17 Sep 2018 08:35:28 -0700
Subject: [PATCH] update sphinx config

---
 docs/_static/flask-favicon.ico                | Bin 2238 -> 0 bytes
 .../{touch-icon.png => flask-icon.png}        | Bin
 .../{flask.png => flask-logo-sidebar.png}     | Bin
 .../_static/{logo-full.png => flask-logo.png} | Bin
 docs/conf.py                                  |  89 +++---------------
 docs/index.rst                                |   7 +-
 6 files changed, 16 insertions(+), 80 deletions(-)
 delete mode 100644 docs/_static/flask-favicon.ico
 rename docs/_static/{touch-icon.png => flask-icon.png} (100%)
 rename docs/_static/{flask.png => flask-logo-sidebar.png} (100%)
 rename docs/_static/{logo-full.png => flask-logo.png} (100%)

diff --git a/docs/_static/flask-favicon.ico b/docs/_static/flask-favicon.ico
deleted file mode 100644
index bf0a961573dcfb1eddccf97c1caefd03b807633c..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001

literal 2238
zcmeIyYb>5;7{Kwr)@$n2SsltS?=Yu1P1&$v&J5d}i<z@+m?=9jS~aY7DDO~*M~Da+
zk|qri64FoA_(FpCg!o3{&^WdZWpB5ondGT2%hE5q@7zzG=lWgOeJ59*+@K(z#>U8>
z%KWYjI)H_I$wPR`*Yo&ULqS0SMMXs<5(!F5N+>HUqoSgMs;Vk#YHFyftD~Wzfu^P=
zT3T9YYipyYr-#12J_ZH`7#bR4WMqU?D#gUa1XEK}%*@O%H#f(^!U9W6ORTJ{u(r0w
z#>NI)TU+ex?69}D$HBn?CnqPIot<%UalzHq6*o6G+}+*r@bJLX(-SW*FTB0I@%8n^
z&(9Bke}4i30tgHYBq%6|;NW0FLP7`)4J9lrjPUSqA|fJ)jEp2IDvIdnXkubwh>eXU
zE-sGv_;?Z$5=cx;Bq=G0<m6;hQc_4wO(iWYjr8<%GBPsA%*-S!D~s&xY;tmP$j!|q
zFE5Y${Co-u3Mecrq^PKf;^JaTN=hg#Ev2lijPmkwDk>_dtgNJ}s*39BYHDg~sI9G~
zuC5N5Oh$cuJq-;FG&MER+}un{OAD>7t+chZ(ca!pM@I*pot<=bb<y43O;1k`y}iBk
z_4U!;-_N~!_qc!mJ_7>-3=R%5G&IEU@Gv7IBaDuYGB!5Gg9i_I`0yd)<KsMf^oWUx
z2_`2enVOnndU~3fnHgqhXPKLuV}5>~g@pwc7Z+JtT4H&5nU$3lR##V9TU%p&eVvVs
z4IV#!%;x4MTU%RfZ*Q}+v%~K0E_-`>JbChjr%#`<zrWAH!2ySdha4Rp@$A_%j*pKy
zIXOA&H~imTK?j8YU^KpT&+7$IZvH-2Qgtme=hW-Pr}HYmPV+U<;gYt*NL}4fD!;c3
z68@19X=lxO>;wD~3cZXiFGpO>3jONF3zvnWcutvQdBExOT0!u7?*%=7sSeiVHO(s)
zLX}I*DfsK7@e6~u-1K#H?^L~hM}&ol%ebmI77I5&YY^i+cWk3B(Nv#NDaQ4#s0xa{
zt-?<wVk{(F1TQsRA=goq8;p3nEH0&1i1}62W8Wpr;g+0IMOpZOH$yMvH{KP#5%upw
zNV<B<T=4j@P}Dz_5Fg$w2)7euqAu0Y5^^);B-U6#ka1o^Ql2i~AV;)3S;Dz@Zptb9
zBT@If^2__5VESEC!!>dL&?oiho7bWPeY}P03XznLFJSp)O3UrLMHdyzMLbJE%{bs&
zOFf&EToILrWEeUIX}(b^u7Xgfgw)`NmY1>6dR;9|ytRLqgt))7_D`t!?QH)y`U<X`
HQ%C**)+P8g

diff --git a/docs/_static/touch-icon.png b/docs/_static/flask-icon.png
similarity index 100%
rename from docs/_static/touch-icon.png
rename to docs/_static/flask-icon.png
diff --git a/docs/_static/flask.png b/docs/_static/flask-logo-sidebar.png
similarity index 100%
rename from docs/_static/flask.png
rename to docs/_static/flask-logo-sidebar.png
diff --git a/docs/_static/logo-full.png b/docs/_static/flask-logo.png
similarity index 100%
rename from docs/_static/logo-full.png
rename to docs/_static/flask-logo.png
diff --git a/docs/conf.py b/docs/conf.py
index f1c4c2b8..00865874 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,9 +1,5 @@
-# -*- coding: utf-8 -*-
 from __future__ import print_function
 
-import inspect
-import re
-
 from pallets_sphinx_themes import ProjectLink, get_version
 
 # Project --------------------------------------------------------------
@@ -16,14 +12,12 @@ release, version = get_version('Flask')
 # General --------------------------------------------------------------
 
 master_doc = 'index'
-
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
     'sphinxcontrib.log_cabinet',
     'pallets_sphinx_themes',
 ]
-
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3/', None),
     'werkzeug': ('http://werkzeug.pocoo.org/docs/', None),
@@ -38,45 +32,32 @@ intersphinx_mapping = {
 # HTML -----------------------------------------------------------------
 
 html_theme = 'flask'
+html_theme_options = {"index_sidebar_logo": False}
 html_context = {
     'project_links': [
-        ProjectLink('Donate to Pallets', 'https://psfmember.org/civicrm/contribute/transact?reset=1&id=20'),
+        ProjectLink('Donate to Pallets', 'https://palletsprojects.com/donate'),
         ProjectLink('Flask Website', 'https://palletsprojects.com/p/flask/'),
         ProjectLink('PyPI releases', 'https://pypi.org/project/Flask/'),
         ProjectLink('Source Code', 'https://github.com/pallets/flask/'),
-        ProjectLink(
-            'Issue Tracker', 'https://github.com/pallets/flask/issues/'),
+        ProjectLink('Issue Tracker', 'https://github.com/pallets/flask/issues/'),
     ],
-    'canonical_url': 'http://flask.pocoo.org/docs/{}/'.format(version),
-    'carbon_ads_args': 'zoneid=1673&serve=C6AILKT&placement=pocooorg',
 }
 html_sidebars = {
-    'index': [
-        'project.html',
-        'versions.html',
-        'carbon_ads.html',
-        'searchbox.html',
-    ],
-    '**': [
-        'localtoc.html',
-        'relations.html',
-        'versions.html',
-        'carbon_ads.html',
-        'searchbox.html',
-    ]
+    'index': ['project.html', "localtoc.html", 'versions.html', 'searchbox.html'],
+    '**': ['localtoc.html', 'relations.html', 'versions.html', 'searchbox.html']
 }
+singlehtml_sidebars = {"index": ["project.html", "versions.html", "localtoc.html"]}
 html_static_path = ['_static']
-html_favicon = '_static/flask-favicon.ico'
-html_logo = '_static/flask.png'
-html_additional_pages = {
-    '404': '404.html',
-}
+html_favicon = '_static/flask-icon.png'
+html_logo = '_static/flask-logo-sidebar.png'
+html_title = "Flask Documentation ({})".format(version)
 html_show_sourcelink = False
+html_domain_indices = False
 
 # LaTeX ----------------------------------------------------------------
 
 latex_documents = [
-    (master_doc, 'Flask.tex', 'Flask Documentation', 'Pallets Team', 'manual'),
+    (master_doc, 'Flask-{}.tex'.format(version), html_title, author, 'manual'),
 ]
 latex_use_modindex = False
 latex_elements = {
@@ -88,54 +69,8 @@ latex_elements = {
 latex_use_parts = True
 latex_additional_files = ['flaskstyle.sty', 'logo.pdf']
 
-# linkcheck ------------------------------------------------------------
-
-linkcheck_anchors = False
-
 # Local Extensions -----------------------------------------------------
 
-def unwrap_decorators():
-    import sphinx.util.inspect as inspect
-    import functools
-
-    old_getargspec = inspect.getargspec
-    def getargspec(x):
-        return old_getargspec(getattr(x, '_original_function', x))
-    inspect.getargspec = getargspec
-
-    old_update_wrapper = functools.update_wrapper
-    def update_wrapper(wrapper, wrapped, *a, **kw):
-        rv = old_update_wrapper(wrapper, wrapped, *a, **kw)
-        rv._original_function = wrapped
-        return rv
-    functools.update_wrapper = update_wrapper
-
-
-unwrap_decorators()
-del unwrap_decorators
-
-
-_internal_mark_re = re.compile(r'^\s*:internal:\s*$(?m)', re.M)
-
-
-def skip_internal(app, what, name, obj, skip, options):
-    docstring = inspect.getdoc(obj) or ''
-
-    if skip or _internal_mark_re.search(docstring) is not None:
-        return True
-
-
-def cut_module_meta(app, what, name, obj, options, lines):
-    """Remove metadata from autodoc output."""
-    if what != 'module':
-        return
-
-    lines[:] = [
-        line for line in lines
-        if not line.startswith((':copyright:', ':license:'))
-    ]
-
-
 def github_link(
     name, rawtext, text, lineno, inliner, options=None, content=None
 ):
@@ -166,6 +101,4 @@ def github_link(
 
 
 def setup(app):
-    app.connect('autodoc-skip-member', skip_internal)
-    app.connect('autodoc-process-docstring', cut_module_meta)
     app.add_role('gh', github_link)
diff --git a/docs/index.rst b/docs/index.rst
index 64ed4e92..b2577079 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,11 +1,14 @@
 :orphan:
 
+.. rst-class:: hide-header
+
 Welcome to Flask
 ================
 
-.. image:: _static/logo-full.png
+.. image:: _static/flask-logo.png
     :alt: Flask: web development, one drop at a time
-    :align: right
+    :align: center
+    :target: https://palletsprojects.com/p/flask/
 
 Welcome to Flask's documentation. Get started with :ref:`installation`
 and then get an overview with the :ref:`quickstart`. There is also a