Merge pull request #2912 from pallets/docs-theme

Update Sphinx conf for recent theme changes

docs/conf.py

@@ -1,164 +1,100 @@
-# -*- coding: utf-8 -*-
 from __future__ import print_function
 
-import inspect
+from pallets_sphinx_themes import get_version
-import re
+from pallets_sphinx_themes import ProjectLink
-
-from pallets_sphinx_themes import ProjectLink, get_version
 
 # Project --------------------------------------------------------------
 
-project = 'Flask'
+project = "Flask"
-copyright = '2010 Pallets Team'
+copyright = "2010 Pallets Team"
-author = 'Pallets Team'
+author = "Pallets Team"
-release, version = get_version('Flask')
+release, version = get_version("Flask")
 
 # General --------------------------------------------------------------
 
-master_doc = 'index'
+master_doc = "index"
-
 extensions = [
-    'sphinx.ext.autodoc',
+    "sphinx.ext.autodoc",
-    'sphinx.ext.intersphinx',
+    "sphinx.ext.intersphinx",
-    'sphinxcontrib.log_cabinet',
+    "sphinxcontrib.log_cabinet",
-    'pallets_sphinx_themes',
+    "pallets_sphinx_themes",
 ]
-
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3/', None),
+    "python": ("https://docs.python.org/3/", None),
-    'werkzeug': ('http://werkzeug.pocoo.org/docs/', None),
+    "werkzeug": ("http://werkzeug.pocoo.org/docs/", None),
-    'click': ('http://click.pocoo.org/', None),
+    "click": ("http://click.pocoo.org/", None),
-    'jinja': ('http://jinja.pocoo.org/docs/', None),
+    "jinja": ("http://jinja.pocoo.org/docs/", None),
-    'itsdangerous': ('https://pythonhosted.org/itsdangerous', None),
+    "itsdangerous": ("https://pythonhosted.org/itsdangerous", None),
-    'sqlalchemy': ('https://docs.sqlalchemy.org/en/latest/', None),
+    "sqlalchemy": ("https://docs.sqlalchemy.org/en/latest/", None),
-    'wtforms': ('https://wtforms.readthedocs.io/en/latest/', None),
+    "wtforms": ("https://wtforms.readthedocs.io/en/latest/", None),
-    'blinker': ('https://pythonhosted.org/blinker/', None),
+    "blinker": ("https://pythonhosted.org/blinker/", None),
 }
 
 # HTML -----------------------------------------------------------------
 
-html_theme = 'flask'
+html_theme = "flask"
+html_theme_options = {"index_sidebar_logo": False}
 html_context = {
-    'project_links': [
+    "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("Flask Website", "https://palletsprojects.com/p/flask/"),
-        ProjectLink('PyPI releases', 'https://pypi.org/project/Flask/'),
+        ProjectLink("PyPI releases", "https://pypi.org/project/Flask/"),
-        ProjectLink('Source Code', 'https://github.com/pallets/flask/'),
+        ProjectLink("Source Code", "https://github.com/pallets/flask/"),
-        ProjectLink(
+        ProjectLink("Issue Tracker", "https://github.com/pallets/flask/issues/"),
-            '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',
     ]
 }
-html_static_path = ['_static']
+html_sidebars = {
-html_favicon = '_static/flask-favicon.ico'
+    "index": ["project.html", "localtoc.html", "versions.html", "searchbox.html"],
-html_logo = '_static/flask.png'
+    "**": ["localtoc.html", "relations.html", "versions.html", "searchbox.html"],
-html_additional_pages = {
-    '404': '404.html',
 }
+singlehtml_sidebars = {"index": ["project.html", "versions.html", "localtoc.html"]}
+html_static_path = ["_static"]
+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 = {
-    'papersize': 'a4paper',
+    "papersize": "a4paper",
-    'pointsize': '12pt',
+    "pointsize": "12pt",
-    'fontpkg': r'\usepackage{mathpazo}',
+    "fontpkg": r"\usepackage{mathpazo}",
-    'preamble': r'\usepackage{flaskstyle}',
+    "preamble": r"\usepackage{flaskstyle}",
 }
 latex_use_parts = True
-latex_additional_files = ['flaskstyle.sty', 'logo.pdf']
+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
 
-
+def github_link(name, rawtext, text, lineno, inliner, options=None, content=None):
-_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
-):
     app = inliner.document.settings.env.app
     release = app.config.release
-    base_url = 'https://github.com/pallets/flask/tree/'
+    base_url = "https://github.com/pallets/flask/tree/"
 
-    if text.endswith('>'):
+    if text.endswith(">"):
-        words, text = text[:-1].rsplit('<', 1)
+        words, text = text[:-1].rsplit("<", 1)
         words = words.strip()
     else:
         words = None
 
-    if release.endswith('dev'):
+    if release.endswith("dev"):
-        url = '{0}master/{1}'.format(base_url, text)
+        url = "{0}master/{1}".format(base_url, text)
     else:
-        url = '{0}{1}/{2}'.format(base_url, release, text)
+        url = "{0}{1}/{2}".format(base_url, release, text)
 
     if words is None:
         words = url
 
     from docutils.nodes import reference
     from docutils.parsers.rst.roles import set_classes
+
     options = options or {}
     set_classes(options)
     node = reference(rawtext, words, refuri=url, **options)
@@ -166,6 +102,4 @@ def github_link(
 
 
 def setup(app):
-    app.connect('autodoc-skip-member', skip_internal)
+    app.add_role("gh", github_link)
-    app.connect('autodoc-process-docstring', cut_module_meta)
-    app.add_role('gh', github_link)

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