maya-chen/flask
1
0
Fork 0
forked from orbit-oss/flask
Code Pull requests Activity

reformat sphinx config

Browse source
This commit is contained in:
David Lord 2018-09-17 08:35:53 -07:00
parent ba868d681a
commit 0f4c9f1d57
No known key found for this signature in database
GPG key ID: 7A1C87E3F5BC42A8
1 changed files with 48 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

95
docs/conf.py
View file

@ -1,55 +1,56 @@
from __future__ import print_function 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 --------------------------------------------------------------
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 -------------------------------------------------------------- # General --------------------------------------------------------------
master_doc = 'index' master_doc = "index"
extensions = [ 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 = { 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 -----------------------------------------------------------------
html_theme = 'flask' html_theme = "flask"
html_theme_options = {"index_sidebar_logo": False} html_theme_options = {"index_sidebar_logo": False}
html_context = { html_context = {
'project_links': [ "project_links": [
ProjectLink('Donate to Pallets', 'https://palletsprojects.com/donate'), 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('Issue Tracker', 'https://github.com/pallets/flask/issues/'), ProjectLink("Issue Tracker", "https://github.com/pallets/flask/issues/"),
], ]
} }
html_sidebars = { html_sidebars = {
'index': ['project.html', "localtoc.html", 'versions.html', 'searchbox.html'], "index": ["project.html", "localtoc.html", "versions.html", "searchbox.html"],
'**': ['localtoc.html', 'relations.html', 'versions.html', 'searchbox.html'] "**": ["localtoc.html", "relations.html", "versions.html", "searchbox.html"],
} }
singlehtml_sidebars = {"index": ["project.html", "versions.html", "localtoc.html"]} singlehtml_sidebars = {"index": ["project.html", "versions.html", "localtoc.html"]}
html_static_path = ['_static'] html_static_path = ["_static"]
html_favicon = '_static/flask-icon.png' html_favicon = "_static/flask-icon.png"
html_logo = '_static/flask-logo-sidebar.png' html_logo = "_static/flask-logo-sidebar.png"
html_title = "Flask Documentation ({})".format(version) html_title = "Flask Documentation ({})".format(version)
html_show_sourcelink = False html_show_sourcelink = False
html_domain_indices = False html_domain_indices = False
@ -57,43 +58,43 @@ html_domain_indices = False
# LaTeX ---------------------------------------------------------------- # LaTeX ----------------------------------------------------------------
latex_documents = [ 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_use_modindex = False
latex_elements = { 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_use_parts = True
latex_additional_files = ['flaskstyle.sty', 'logo.pdf'] latex_additional_files = ["flaskstyle.sty", "logo.pdf"]
# Local Extensions ----------------------------------------------------- # 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 app = inliner.document.settings.env.app
release = app.config.release 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() words = words.strip()
else: else:
words = None 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: else:
url = '{0}{1}/{2}'.format(base_url, release, text) url = "{0}{1}/{2}".format(base_url, release, text)
if words is None: if words is None:
words = url words = url
from docutils.nodes import reference from docutils.nodes import reference
from docutils.parsers.rst.roles import set_classes from docutils.parsers.rst.roles import set_classes
options = options or {} options = options or {}
set_classes(options) set_classes(options)
node = reference(rawtext, words, refuri=url, **options) node = reference(rawtext, words, refuri=url, **options)
@ -101,4 +102,4 @@ def github_link(
def setup(app): def setup(app):
app.add_role('gh', github_link) app.add_role("gh", github_link)