From 0f4c9f1d57cc72e1407364f1cdac5737ee3c60f5 Mon Sep 17 00:00:00 2001 From: David Lord Date: Mon, 17 Sep 2018 08:35:53 -0700 Subject: [PATCH] reformat sphinx config --- docs/conf.py | 95 ++++++++++++++++++++++++++-------------------------- 1 file changed, 48 insertions(+), 47 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 00865874..053960fa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,55 +1,56 @@ from __future__ import print_function -from pallets_sphinx_themes import ProjectLink, get_version +from pallets_sphinx_themes import get_version +from pallets_sphinx_themes import ProjectLink # Project -------------------------------------------------------------- -project = 'Flask' -copyright = '2010 Pallets Team' -author = 'Pallets Team' -release, version = get_version('Flask') +project = "Flask" +copyright = "2010 Pallets Team" +author = "Pallets Team" +release, version = get_version("Flask") # General -------------------------------------------------------------- -master_doc = 'index' +master_doc = "index" extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinxcontrib.log_cabinet', - 'pallets_sphinx_themes', + "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), - 'click': ('http://click.pocoo.org/', None), - 'jinja': ('http://jinja.pocoo.org/docs/', None), - 'itsdangerous': ('https://pythonhosted.org/itsdangerous', None), - 'sqlalchemy': ('https://docs.sqlalchemy.org/en/latest/', None), - 'wtforms': ('https://wtforms.readthedocs.io/en/latest/', None), - 'blinker': ('https://pythonhosted.org/blinker/', None), + "python": ("https://docs.python.org/3/", None), + "werkzeug": ("http://werkzeug.pocoo.org/docs/", None), + "click": ("http://click.pocoo.org/", None), + "jinja": ("http://jinja.pocoo.org/docs/", None), + "itsdangerous": ("https://pythonhosted.org/itsdangerous", None), + "sqlalchemy": ("https://docs.sqlalchemy.org/en/latest/", None), + "wtforms": ("https://wtforms.readthedocs.io/en/latest/", 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': [ - 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/'), - ], + "project_links": [ + 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/"), + ] } html_sidebars = { - 'index': ['project.html', "localtoc.html", 'versions.html', 'searchbox.html'], - '**': ['localtoc.html', 'relations.html', 'versions.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-icon.png' -html_logo = '_static/flask-logo-sidebar.png' +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 @@ -57,43 +58,43 @@ html_domain_indices = False # LaTeX ---------------------------------------------------------------- latex_documents = [ - (master_doc, 'Flask-{}.tex'.format(version), html_title, author, 'manual'), + (master_doc, "Flask-{}.tex".format(version), html_title, author, "manual") ] latex_use_modindex = False latex_elements = { - 'papersize': 'a4paper', - 'pointsize': '12pt', - 'fontpkg': r'\usepackage{mathpazo}', - 'preamble': r'\usepackage{flaskstyle}', + "papersize": "a4paper", + "pointsize": "12pt", + "fontpkg": r"\usepackage{mathpazo}", + "preamble": r"\usepackage{flaskstyle}", } latex_use_parts = True -latex_additional_files = ['flaskstyle.sty', 'logo.pdf'] +latex_additional_files = ["flaskstyle.sty", "logo.pdf"] # Local Extensions ----------------------------------------------------- -def github_link( - name, rawtext, text, lineno, inliner, options=None, content=None -): + +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('>'): - words, text = text[:-1].rsplit('<', 1) + if text.endswith(">"): + words, text = text[:-1].rsplit("<", 1) words = words.strip() else: words = None - if release.endswith('dev'): - url = '{0}master/{1}'.format(base_url, text) + if release.endswith("dev"): + 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) @@ -101,4 +102,4 @@ def github_link( def setup(app): - app.add_role('gh', github_link) + app.add_role("gh", github_link)