Merge pull request #75 from manheim/c7n-update

CHANGES.rst

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+1.4.3 (2022-05-24)
+------------------
+
+* Bump c7n to release 0.9.16
+* Bump c7n-mailer to release 0.6.15 
+* Update sphinx dependencies to 4.x
+
 1.4.2 (2022-05-20)
 ------------------
 

docs/requirements.txt

@@ -1,3 +1,3 @@
 pygments
-m2r
-mistune==0.8.4
+m2r2
+mistune==0.8.4

docs/source/conf.py

@@ -26,7 +26,7 @@
 # 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('.'))
 
 is_rtd = os.environ.get('READTHEDOCS', None) != 'True'
 readthedocs_version = os.environ.get('READTHEDOCS_VERSION', '')
@@ -41,7 +41,7 @@
 # -- 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
@@ -52,7 +52,7 @@
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
     'sphinx.ext.viewcode',
-    'm2r'
+    'm2r2'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -64,7 +64,7 @@
 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'
@@ -92,37 +92,37 @@
 
 # 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 = []
 
 # 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'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
@@ -147,87 +147,87 @@
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
-#html_extra_path = []
+# html_extra_path = []
 
-html_context = {
-    'css_files': [
-        # thanks to: https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
-        '_static/theme_overrides.css',  # override wide tables in RTD theme
-    ],
-}
+# thanks to: https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
+#   see: https://docs.readthedocs.io/en/stable/guides/adding-custom-css.html
+#   for the updated way to do this (as used here)
+html_css_files = [
+    '_static/theme_overrides.css',  # override wide tables in RTD theme
+]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 html_last_updated_fmt = '%b %d, %Y'
 
 # 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 = True
+# html_domain_indices = True
 
 # 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, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # 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
 
 # Language to be used for generating the HTML full-text search index.
 # Sphinx supports the following languages:
 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
 #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
-#html_search_language = 'en'
+# html_search_language = 'en'
 
 # A dictionary with options for the search language support, empty by default.
 # Now only 'ja' uses this config value
-#html_search_options = {'type': 'default'}
+# html_search_options = {'type': 'default'}
 
 # The name of a javascript file (relative to the configuration directory) that
 # implements a search results scorer. If empty, the default will be used.
-#html_search_scorer = 'scorer.js'
+# html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-#htmlhelp_basename = 'manheim-c7n-toolsdoc'
+# htmlhelp_basename = 'manheim-c7n-toolsdoc'
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
 # The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+# 'papersize': 'letterpaper',
 
 # The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+# 'pointsize': '10pt',
 
 # Additional stuff for the LaTeX preamble.
-#'preamble': '',
+# 'preamble': '',
 
 # Latex figure (float) alignment
-#'figure_align': 'htbp',
+# ' figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
@@ -240,23 +240,23 @@
 
 # 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
 
 # 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
 
 
 # -- Options for manual page output ---------------------------------------
@@ -269,7 +269,7 @@
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -284,16 +284,16 @@
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
@@ -325,11 +325,13 @@
     r'https?://.*wikipedia\.org.*'
 ]
 
+
 # exclude module docstrings - see http://stackoverflow.com/a/18031024/211734
 def remove_module_docstring(app, what, name, obj, options, lines):
     if what == "module":
         del lines[:]
 
+
 # ignore non-local image warnings
 def _warn_node(self, msg, node, **kwargs):
     if not (
@@ -340,6 +342,7 @@ def _warn_node(self, msg, node, **kwargs):
     ):
         self._warnfunc(msg, '%s:%s' % get_source_line(node))
 
+
 sphinx.environment.BuildEnvironment.warn_node = _warn_node
 
 
@@ -503,6 +506,7 @@ def on_doctree_read(_, doctree):
 
 # END code to replace hard-coded links in README with internal references
 
+
 def setup(app):
     app.connect("autodoc-process-docstring", remove_module_docstring)
     app.connect('doctree-read', on_doctree_read)

docs/source/manheim_c7n_tools.config.rst

@@ -2,6 +2,6 @@ manheim\_c7n\_tools.config module
 =================================
 
 .. automodule:: manheim_c7n_tools.config
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/manheim_c7n_tools.dryrun_diff.rst

@@ -2,6 +2,6 @@ manheim\_c7n\_tools.dryrun\_diff module
 =======================================
 
 .. automodule:: manheim_c7n_tools.dryrun_diff
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/manheim_c7n_tools.errorscan.rst

@@ -2,6 +2,6 @@ manheim\_c7n\_tools.errorscan module
 ====================================
 
 .. automodule:: manheim_c7n_tools.errorscan
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/manheim_c7n_tools.notifyonly.rst

@@ -2,6 +2,6 @@ manheim\_c7n\_tools.notifyonly module
 =====================================
 
 .. automodule:: manheim_c7n_tools.notifyonly
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/manheim_c7n_tools.policygen.rst

@@ -2,6 +2,6 @@ manheim\_c7n\_tools.policygen module
 ====================================
 
 .. automodule:: manheim_c7n_tools.policygen
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/manheim_c7n_tools.rst

@@ -2,21 +2,23 @@ manheim\_c7n\_tools package
 ===========================
 
 .. automodule:: manheim_c7n_tools
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Subpackages
 -----------
 
 .. toctree::
+   :maxdepth: 4
 
-    manheim_c7n_tools.vendor
+   manheim_c7n_tools.vendor
 
 Submodules
 ----------
 
 .. toctree::
+   :maxdepth: 4
 
    manheim_c7n_tools.config
    manheim_c7n_tools.dryrun_diff
@@ -27,4 +29,3 @@ Submodules
    manheim_c7n_tools.s3_archiver
    manheim_c7n_tools.utils
    manheim_c7n_tools.version
-

docs/source/manheim_c7n_tools.runner.rst

@@ -2,6 +2,6 @@ manheim\_c7n\_tools.runner module
 =================================
 
 .. automodule:: manheim_c7n_tools.runner
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance: