Skip to content

Commit 82f077d

Browse files
Merge pull request #75 from manheim/c7n-update
2 parents ae3c803 + ea7d6bd commit 82f077d

19 files changed

+112
-98
lines changed

CHANGES.rst

+7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
Changelog
22
=========
33

4+
1.4.3 (2022-05-24)
5+
------------------
6+
7+
* Bump c7n to release 0.9.16
8+
* Bump c7n-mailer to release 0.6.15
9+
* Update sphinx dependencies to 4.x
10+
411
1.4.2 (2022-05-20)
512
------------------
613

docs/requirements.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
pygments
2-
m2r
3-
mistune==0.8.4
2+
m2r2
3+
mistune==0.8.4

docs/source/conf.py

+53-49
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
# If extensions (or modules to document with autodoc) are in another directory,
2727
# add these directories to sys.path here. If the directory is relative to the
2828
# documentation root, use os.path.abspath to make it absolute, like shown here.
29-
#sys.path.insert(0, os.path.abspath('.'))
29+
# sys.path.insert(0, os.path.abspath('.'))
3030

3131
is_rtd = os.environ.get('READTHEDOCS', None) != 'True'
3232
readthedocs_version = os.environ.get('READTHEDOCS_VERSION', '')
@@ -41,7 +41,7 @@
4141
# -- General configuration ------------------------------------------------
4242

4343
# If your documentation needs a minimal Sphinx version, state it here.
44-
#needs_sphinx = '1.0'
44+
# needs_sphinx = '1.0'
4545

4646
# Add any Sphinx extension module names here, as strings. They can be
4747
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -52,7 +52,7 @@
5252
'sphinx.ext.todo',
5353
'sphinx.ext.coverage',
5454
'sphinx.ext.viewcode',
55-
'm2r'
55+
'm2r2'
5656
]
5757

5858
# Add any paths that contain templates here, relative to this directory.
@@ -64,7 +64,7 @@
6464
source_suffix = '.rst'
6565

6666
# The encoding of source files.
67-
#source_encoding = 'utf-8-sig'
67+
# source_encoding = 'utf-8-sig'
6868

6969
# The master toctree document.
7070
master_doc = 'index'
@@ -92,37 +92,37 @@
9292

9393
# There are two options for replacing |today|: either, you set today to some
9494
# non-false value, then it is used:
95-
#today = ''
95+
# today = ''
9696
# Else, today_fmt is used as the format for a strftime call.
97-
#today_fmt = '%B %d, %Y'
97+
# today_fmt = '%B %d, %Y'
9898

9999
# List of patterns, relative to source directory, that match files and
100100
# directories to ignore when looking for source files.
101101
exclude_patterns = []
102102

103103
# The reST default role (used for this markup: `text`) to use for all
104104
# documents.
105-
#default_role = None
105+
# default_role = None
106106

107107
# If true, '()' will be appended to :func: etc. cross-reference text.
108-
#add_function_parentheses = True
108+
# add_function_parentheses = True
109109

110110
# If true, the current module name will be prepended to all description
111111
# unit titles (such as .. function::).
112-
#add_module_names = True
112+
# add_module_names = True
113113

114114
# If true, sectionauthor and moduleauthor directives will be shown in the
115115
# output. They are ignored by default.
116-
#show_authors = False
116+
# show_authors = False
117117

118118
# The name of the Pygments (syntax highlighting) style to use.
119119
pygments_style = 'sphinx'
120120

121121
# A list of ignored prefixes for module index sorting.
122-
#modindex_common_prefix = []
122+
# modindex_common_prefix = []
123123

124124
# If true, keep warnings as "system message" paragraphs in the built documents.
125-
#keep_warnings = False
125+
# keep_warnings = False
126126

127127
# If true, `todo` and `todoList` produce output, else they produce nothing.
128128
todo_include_todos = True
@@ -147,87 +147,87 @@
147147
# Add any extra paths that contain custom files (such as robots.txt or
148148
# .htaccess) here, relative to this directory. These files are copied
149149
# directly to the root of the documentation.
150-
#html_extra_path = []
150+
# html_extra_path = []
151151

152-
html_context = {
153-
'css_files': [
154-
# thanks to: https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
155-
'_static/theme_overrides.css', # override wide tables in RTD theme
156-
],
157-
}
152+
# thanks to: https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
153+
# see: https://docs.readthedocs.io/en/stable/guides/adding-custom-css.html
154+
# for the updated way to do this (as used here)
155+
html_css_files = [
156+
'_static/theme_overrides.css', # override wide tables in RTD theme
157+
]
158158

159159
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
160160
# using the given strftime format.
161161
html_last_updated_fmt = '%b %d, %Y'
162162

163163
# If true, SmartyPants will be used to convert quotes and dashes to
164164
# typographically correct entities.
165-
#html_use_smartypants = True
165+
# html_use_smartypants = True
166166

167167
# Custom sidebar templates, maps document names to template names.
168-
#html_sidebars = {}
168+
# html_sidebars = {}
169169

170170
# Additional templates that should be rendered to pages, maps page names to
171171
# template names.
172-
#html_additional_pages = {}
172+
# html_additional_pages = {}
173173

174174
# If false, no module index is generated.
175-
#html_domain_indices = True
175+
# html_domain_indices = True
176176

177177
# If false, no index is generated.
178-
#html_use_index = True
178+
# html_use_index = True
179179

180180
# If true, the index is split into individual pages for each letter.
181-
#html_split_index = False
181+
# html_split_index = False
182182

183183
# If true, links to the reST sources are added to the pages.
184-
#html_show_sourcelink = True
184+
# html_show_sourcelink = True
185185

186186
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
187-
#html_show_sphinx = True
187+
# html_show_sphinx = True
188188

189189
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
190-
#html_show_copyright = True
190+
# html_show_copyright = True
191191

192192
# If true, an OpenSearch description file will be output, and all pages will
193193
# contain a <link> tag referring to it. The value of this option must be the
194194
# base URL from which the finished HTML is served.
195-
#html_use_opensearch = ''
195+
# html_use_opensearch = ''
196196

197197
# This is the file name suffix for HTML files (e.g. ".xhtml").
198-
#html_file_suffix = None
198+
# html_file_suffix = None
199199

200200
# Language to be used for generating the HTML full-text search index.
201201
# Sphinx supports the following languages:
202202
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
203203
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
204-
#html_search_language = 'en'
204+
# html_search_language = 'en'
205205

206206
# A dictionary with options for the search language support, empty by default.
207207
# Now only 'ja' uses this config value
208-
#html_search_options = {'type': 'default'}
208+
# html_search_options = {'type': 'default'}
209209

210210
# The name of a javascript file (relative to the configuration directory) that
211211
# implements a search results scorer. If empty, the default will be used.
212-
#html_search_scorer = 'scorer.js'
212+
# html_search_scorer = 'scorer.js'
213213

214214
# Output file base name for HTML help builder.
215-
#htmlhelp_basename = 'manheim-c7n-toolsdoc'
215+
# htmlhelp_basename = 'manheim-c7n-toolsdoc'
216216

217217
# -- Options for LaTeX output ---------------------------------------------
218218

219219
latex_elements = {
220220
# The paper size ('letterpaper' or 'a4paper').
221-
#'papersize': 'letterpaper',
221+
# 'papersize': 'letterpaper',
222222

223223
# The font size ('10pt', '11pt' or '12pt').
224-
#'pointsize': '10pt',
224+
# 'pointsize': '10pt',
225225

226226
# Additional stuff for the LaTeX preamble.
227-
#'preamble': '',
227+
# 'preamble': '',
228228

229229
# Latex figure (float) alignment
230-
#'figure_align': 'htbp',
230+
# ' figure_align': 'htbp',
231231
}
232232

233233
# Grouping the document tree into LaTeX files. List of tuples
@@ -240,23 +240,23 @@
240240

241241
# The name of an image file (relative to this directory) to place at the top of
242242
# the title page.
243-
#latex_logo = None
243+
# latex_logo = None
244244

245245
# For "manual" documents, if this is true, then toplevel headings are parts,
246246
# not chapters.
247-
#latex_use_parts = False
247+
# latex_use_parts = False
248248

249249
# If true, show page references after internal links.
250-
#latex_show_pagerefs = False
250+
# latex_show_pagerefs = False
251251

252252
# If true, show URL addresses after external links.
253-
#latex_show_urls = False
253+
# latex_show_urls = False
254254

255255
# Documents to append as an appendix to all manuals.
256-
#latex_appendices = []
256+
# latex_appendices = []
257257

258258
# If false, no module index is generated.
259-
#latex_domain_indices = True
259+
# latex_domain_indices = True
260260

261261

262262
# -- Options for manual page output ---------------------------------------
@@ -269,7 +269,7 @@
269269
]
270270

271271
# If true, show URL addresses after external links.
272-
#man_show_urls = False
272+
# man_show_urls = False
273273

274274

275275
# -- Options for Texinfo output -------------------------------------------
@@ -284,16 +284,16 @@
284284
]
285285

286286
# Documents to append as an appendix to all manuals.
287-
#texinfo_appendices = []
287+
# texinfo_appendices = []
288288

289289
# If false, no module index is generated.
290-
#texinfo_domain_indices = True
290+
# texinfo_domain_indices = True
291291

292292
# How to display URL addresses: 'footnote', 'no', or 'inline'.
293-
#texinfo_show_urls = 'footnote'
293+
# texinfo_show_urls = 'footnote'
294294

295295
# If true, do not generate a @detailmenu in the "Top" node's menu.
296-
#texinfo_no_detailmenu = False
296+
# texinfo_no_detailmenu = False
297297

298298

299299
# Example configuration for intersphinx: refer to the Python standard library.
@@ -325,11 +325,13 @@
325325
r'https?://.*wikipedia\.org.*'
326326
]
327327

328+
328329
# exclude module docstrings - see http://stackoverflow.com/a/18031024/211734
329330
def remove_module_docstring(app, what, name, obj, options, lines):
330331
if what == "module":
331332
del lines[:]
332333

334+
333335
# ignore non-local image warnings
334336
def _warn_node(self, msg, node, **kwargs):
335337
if not (
@@ -340,6 +342,7 @@ def _warn_node(self, msg, node, **kwargs):
340342
):
341343
self._warnfunc(msg, '%s:%s' % get_source_line(node))
342344

345+
343346
sphinx.environment.BuildEnvironment.warn_node = _warn_node
344347

345348

@@ -503,6 +506,7 @@ def on_doctree_read(_, doctree):
503506

504507
# END code to replace hard-coded links in README with internal references
505508

509+
506510
def setup(app):
507511
app.connect("autodoc-process-docstring", remove_module_docstring)
508512
app.connect('doctree-read', on_doctree_read)

docs/source/manheim_c7n_tools.config.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ manheim\_c7n\_tools.config module
22
=================================
33

44
.. automodule:: manheim_c7n_tools.config
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/source/manheim_c7n_tools.dryrun_diff.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ manheim\_c7n\_tools.dryrun\_diff module
22
=======================================
33

44
.. automodule:: manheim_c7n_tools.dryrun_diff
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/source/manheim_c7n_tools.errorscan.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ manheim\_c7n\_tools.errorscan module
22
====================================
33

44
.. automodule:: manheim_c7n_tools.errorscan
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/source/manheim_c7n_tools.notifyonly.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ manheim\_c7n\_tools.notifyonly module
22
=====================================
33

44
.. automodule:: manheim_c7n_tools.notifyonly
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/source/manheim_c7n_tools.policygen.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ manheim\_c7n\_tools.policygen module
22
====================================
33

44
.. automodule:: manheim_c7n_tools.policygen
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/source/manheim_c7n_tools.rst

+6-5
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,23 @@ manheim\_c7n\_tools package
22
===========================
33

44
.. automodule:: manheim_c7n_tools
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
88

99
Subpackages
1010
-----------
1111

1212
.. toctree::
13+
:maxdepth: 4
1314

14-
manheim_c7n_tools.vendor
15+
manheim_c7n_tools.vendor
1516

1617
Submodules
1718
----------
1819

1920
.. toctree::
21+
:maxdepth: 4
2022

2123
manheim_c7n_tools.config
2224
manheim_c7n_tools.dryrun_diff
@@ -27,4 +29,3 @@ Submodules
2729
manheim_c7n_tools.s3_archiver
2830
manheim_c7n_tools.utils
2931
manheim_c7n_tools.version
30-

docs/source/manheim_c7n_tools.runner.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ manheim\_c7n\_tools.runner module
22
=================================
33

44
.. automodule:: manheim_c7n_tools.runner
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

0 commit comments

Comments
 (0)