From 1c29e84f7f371d17baa81726f7fdcbc892d0dbe7 Mon Sep 17 00:00:00 2001
From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Thu, 1 Aug 2019 12:22:32 -0400
Subject: - add changelog section headers - reformats conf.py with black

Change-Id: If011cb43578ae8deab645e654d0785576206f90f
---
 doc/build/changelog.rst      |   2 +-
 doc/build/conf.py            | 173 ++++++++++++++++++++++++-------------------
 doc/build/unreleased/249.rst |   2 +-
 doc/build/unreleased/303.rst |   2 +-
 4 files changed, 99 insertions(+), 80 deletions(-)

(limited to 'doc')

diff --git a/doc/build/changelog.rst b/doc/build/changelog.rst
index e15884c..7f073cd 100644
--- a/doc/build/changelog.rst
+++ b/doc/build/changelog.rst
@@ -73,7 +73,7 @@ Changelog
     :released: Fri May 31 2019
 
     .. change::
-        :tags: change
+        :tags: changed
 
         Updated for additional project metadata in setup.py.   Additionally,
         the code has been reformatted using Black and zimports.
diff --git a/doc/build/conf.py b/doc/build/conf.py
index 4e3e2bb..04b9423 100644
--- a/doc/build/conf.py
+++ b/doc/build/conf.py
@@ -10,28 +10,35 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
+import os
+import sys
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('../..'))
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath("../.."))
+sys.path.insert(0, os.path.abspath("."))
+
+if True:
+    import mako  # noqa
 
-import mako
 
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-#extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode',
+# extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode',
 #                'sphinx.ext.doctest', 'builder.builders']
 
-extensions = ['sphinx.ext.autodoc',
-                'changelog', 'sphinx_paramlinks', 'zzzeeksphinx']
+extensions = [
+    "sphinx.ext.autodoc",
+    "changelog",
+    "sphinx_paramlinks",
+    "zzzeeksphinx",
+]
 
 changelog_render_ticket = "https://github.com/sqlalchemy/mako/issues/%s"
 
@@ -40,8 +47,19 @@ changelog_render_pullreq = {
     "github": "https://github.com/sqlalchemy/mako/pull/%s",
 }
 
+# tags to sort on inside of sections
+changelog_sections = [
+    "changed",
+    "feature",
+    "bug",
+    "usecase",
+    "moved",
+    "removed",
+]
+
+
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['templates']
+templates_path = ["templates"]
 
 nitpicky = True
 
@@ -51,17 +69,17 @@ site_adapter_template = "docs_adapter.mako"
 site_adapter_py = "docs_adapter.py"
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'Mako'
-copyright = u'the Mako authors and contributors'
+project = u"Mako"
+copyright = u"the Mako authors and contributors"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -74,220 +92,221 @@ release = "1.0.14"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['build']
+exclude_patterns = ["build"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 
 # -- Options for HTML output ---------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'zsmako'
+html_theme = "zsmako"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The style sheet to use for HTML and HTML Help pages. A file of that name
 # must exist either in Sphinx' static/ path, or in one of the custom paths
 # given in html_static_path.
-html_style = 'default.css'
+html_style = "default.css"
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 html_title = "%s %s Documentation" % (project, release)
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['static']
+html_static_path = ["static"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-html_last_updated_fmt = '%m/%d/%Y %H:%M:%S'
+html_last_updated_fmt = "%m/%d/%Y %H:%M:%S"
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
 html_domain_indices = False
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, the reST sources are included in the HTML build as _sources/<name>.
-#html_copy_source = True
+# html_copy_source = True
 html_copy_source = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 html_show_sourcelink = False
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Makodoc'
+htmlhelp_basename = "Makodoc"
 
-#autoclass_content = 'both'
+# autoclass_content = 'both'
 
 # -- Options for LaTeX output --------------------------------------------------
 
 # The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+# latex_paper_size = 'letter'
 
 # The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# latex_font_size = '10pt'
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'mako_%s.tex' % release.replace('.', '_'), u'Mako Documentation',
-   u'Mike Bayer', 'manual'),
+    (
+        "index",
+        "mako_%s.tex" % release.replace(".", "_"),
+        u"Mako Documentation",
+        u"Mike Bayer",
+        "manual",
+    )
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Additional stuff for the LaTeX preamble.
 # sets TOC depth to 2.
-latex_preamble = '\setcounter{tocdepth}{3}'
+latex_preamble = "\setcounter{tocdepth}{3}"
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
-#latex_elements = {
+# latex_elements = {
 #    'papersize': 'letterpaper',
 #    'pointsize': '10pt',
-#}
+# }
 
 # -- Options for manual page output --------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'mako', u'Mako Documentation',
-     [u'Mako authors'], 1)
-]
+man_pages = [("index", "mako", u"Mako Documentation", [u"Mako authors"], 1)]
 
 
 # -- Options for Epub output ---------------------------------------------------
 
 # Bibliographic Dublin Core info.
-epub_title = u'Mako'
-epub_author = u'Mako authors'
-epub_publisher = u'Mako authors'
-epub_copyright = u'Mako authors'
+epub_title = u"Mako"
+epub_author = u"Mako authors"
+epub_publisher = u"Mako authors"
+epub_copyright = u"Mako authors"
 
 # The language of the text. It defaults to the language option
 # or en if the language is not set.
-#epub_language = ''
+# epub_language = ''
 
 # The scheme of the identifier. Typical schemes are ISBN or URL.
-#epub_scheme = ''
+# epub_scheme = ''
 
 # The unique identifier of the text. This can be a ISBN number
 # or the project homepage.
-#epub_identifier = ''
+# epub_identifier = ''
 
 # A unique identification for the text.
-#epub_uid = ''
+# epub_uid = ''
 
 # HTML files that should be inserted before the pages created by sphinx.
 # The format is a list of tuples containing the path and title.
-#epub_pre_files = []
+# epub_pre_files = []
 
 # HTML files shat should be inserted after the pages created by sphinx.
 # The format is a list of tuples containing the path and title.
-#epub_post_files = []
+# epub_post_files = []
 
 # A list of files that should not be packed into the epub file.
-#epub_exclude_files = []
+# epub_exclude_files = []
 
 # The depth of the table of contents in toc.ncx.
-#epub_tocdepth = 3
+# epub_tocdepth = 3
 
 # Allow duplicate toc entries.
-#epub_tocdup = True
-
+# epub_tocdup = True
diff --git a/doc/build/unreleased/249.rst b/doc/build/unreleased/249.rst
index 206a72a..da9767c 100644
--- a/doc/build/unreleased/249.rst
+++ b/doc/build/unreleased/249.rst
@@ -1,5 +1,5 @@
 .. change::
-    :tags: change, py3k, installer
+    :tags: changed, py3k, installer
     :tickets: 249
 
     Mako 1.1 now supports Python versions:
diff --git a/doc/build/unreleased/303.rst b/doc/build/unreleased/303.rst
index de5a01a..ac65612 100644
--- a/doc/build/unreleased/303.rst
+++ b/doc/build/unreleased/303.rst
@@ -1,5 +1,5 @@
 .. change::
-    :tags: bug, setup
+    :tags: changed, setup
     :tickets: 303
 
     Removed the "python setup.py test" feature in favor of a straight run of
-- 
cgit v1.2.3