Skip to content

Commit c12110d

Browse files
author
Jon Wayne Parrott
authored
Regenerate gapic cilent for error_reporting (#4743)
* Import error_reporting gapic generated from artman Command log: ``` set DEST ~/workspace/google-cloud-python/error_reporting set GOOGLEAPIS_REV = 9370390e321dae510e7092d05d9f583076d3977b cd /tmp git clone https://github.com/googleapis/googleapis.git cd googleapis git reset hard $GOOGLEAPIS_REV artman --config google/devtools/clouderrorreporting/artman_errorreporting.yaml generate python_gapic set SRC ./artman-genfiles/python/error-reporting-v1beta1/ cp -r $SRC/docs $DEST mkdir -p $DEST/google/cloud/errorreporting_v1beta1 cp -r $SRC/google/cloud/errorreporting_v1beta1/gapic $DEST/google/cloud/errorreporting_v1beta1 cp -r $SRC/google/cloud/errorreporting_v1beta1/proto $DEST/google/cloud/errorreporting_v1beta1 cp -r $SRC/google/cloud/errorreporting_v1beta1/{__init__.py,types.py} $DEST/google/cloud/errorreporting_v1beta1 mkdir -p $DEST/tests/unit/gapic cp -r $SRC/tests/unit/gapic $DEST/tests/unit mkdir -p $DEST/tests/system/gapic cp -r $SRC/tests/system/gapic $DEST/tests/system ``` * Generator Bug: Fixup proto imports that reference the incorrect package. * Replace gax usage with gapic client
1 parent f742978 commit c12110d

33 files changed

+4624
-52
lines changed

docs/conf.py

Lines changed: 311 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,311 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# google-cloud-error-reporting documentation build configuration file
4+
#
5+
# This file is execfile()d with the current directory set to its
6+
# containing dir.
7+
#
8+
# Note that not all possible configuration values are present in this
9+
# autogenerated file.
10+
#
11+
# All configuration values have a default; values that are commented out
12+
# serve to show the default.
13+
14+
import sys
15+
import os
16+
import shlex
17+
18+
# If extensions (or modules to document with autodoc) are in another directory,
19+
# add these directories to sys.path here. If the directory is relative to the
20+
# documentation root, use os.path.abspath to make it absolute, like shown here.
21+
sys.path.insert(0, os.path.abspath('..'))
22+
23+
__version__ = '0.1.0'
24+
25+
# -- General configuration ------------------------------------------------
26+
27+
# If your documentation needs a minimal Sphinx version, state it here.
28+
#needs_sphinx = '1.0'
29+
30+
# Add any Sphinx extension module names here, as strings. They can be
31+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32+
# ones.
33+
extensions = [
34+
'sphinx.ext.autodoc',
35+
'sphinx.ext.autosummary',
36+
'sphinx.ext.intersphinx',
37+
'sphinx.ext.coverage',
38+
'sphinx.ext.napoleon',
39+
'sphinx.ext.viewcode',
40+
]
41+
42+
# autodoc/autosummary flags
43+
autoclass_content = 'both'
44+
autodoc_default_flags = ['members']
45+
autosummary_generate = True
46+
47+
# Add any paths that contain templates here, relative to this directory.
48+
templates_path = ['_templates']
49+
50+
# The suffix(es) of source filenames.
51+
# You can specify multiple suffix as a list of string:
52+
# source_suffix = ['.rst', '.md']
53+
source_suffix = '.rst'
54+
55+
# The encoding of source files.
56+
#source_encoding = 'utf-8-sig'
57+
58+
# The master toctree document.
59+
master_doc = 'index'
60+
61+
# General information about the project.
62+
project = u'google-cloud-error-reporting'
63+
copyright = u'2017, Google'
64+
author = u'Google APIs'
65+
66+
# The version info for the project you're documenting, acts as replacement for
67+
# |version| and |release|, also used in various other places throughout the
68+
# built documents.
69+
#
70+
# The full version, including alpha/beta/rc tags.
71+
release = __version__
72+
# The short X.Y version.
73+
version = '.'.join(release.split('.')[0:2])
74+
75+
# The language for content autogenerated by Sphinx. Refer to documentation
76+
# for a list of supported languages.
77+
#
78+
# This is also used if you do content translation via gettext catalogs.
79+
# Usually you set "language" from the command line for these cases.
80+
language = None
81+
82+
# There are two options for replacing |today|: either, you set today to some
83+
# non-false value, then it is used:
84+
#today = ''
85+
# Else, today_fmt is used as the format for a strftime call.
86+
#today_fmt = '%B %d, %Y'
87+
88+
# List of patterns, relative to source directory, that match files and
89+
# directories to ignore when looking for source files.
90+
exclude_patterns = ['_build']
91+
92+
# The reST default role (used for this markup: `text`) to use for all
93+
# documents.
94+
#default_role = None
95+
96+
# If true, '()' will be appended to :func: etc. cross-reference text.
97+
#add_function_parentheses = True
98+
99+
# If true, the current module name will be prepended to all description
100+
# unit titles (such as .. function::).
101+
#add_module_names = True
102+
103+
# If true, sectionauthor and moduleauthor directives will be shown in the
104+
# output. They are ignored by default.
105+
#show_authors = False
106+
107+
# The name of the Pygments (syntax highlighting) style to use.
108+
pygments_style = 'sphinx'
109+
110+
# A list of ignored prefixes for module index sorting.
111+
#modindex_common_prefix = []
112+
113+
# If true, keep warnings as "system message" paragraphs in the built documents.
114+
#keep_warnings = False
115+
116+
# If true, `todo` and `todoList` produce output, else they produce nothing.
117+
todo_include_todos = True
118+
119+
# -- Options for HTML output ----------------------------------------------
120+
121+
# The theme to use for HTML and HTML Help pages. See the documentation for
122+
# a list of builtin themes.
123+
html_theme = 'sphinx_rtd_theme'
124+
125+
# Theme options are theme-specific and customize the look and feel of a theme
126+
# further. For a list of options available for each theme, see the
127+
# documentation.
128+
#html_theme_options = {}
129+
130+
# Add any paths that contain custom themes here, relative to this directory.
131+
#html_theme_path = []
132+
133+
# The name for this set of Sphinx documents. If None, it defaults to
134+
# "<project> v<release> documentation".
135+
#html_title = None
136+
137+
# A shorter title for the navigation bar. Default is the same as html_title.
138+
#html_short_title = None
139+
140+
# The name of an image file (relative to this directory) to place at the top
141+
# of the sidebar.
142+
#html_logo = None
143+
144+
# The name of an image file (within the static path) to use as favicon of the
145+
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
146+
# pixels large.
147+
#html_favicon = None
148+
149+
# Add any paths that contain custom static files (such as style sheets) here,
150+
# relative to this directory. They are copied after the builtin static files,
151+
# so a file named "default.css" will overwrite the builtin "default.css".
152+
# html_static_path = []
153+
154+
# Add any extra paths that contain custom files (such as robots.txt or
155+
# .htaccess) here, relative to this directory. These files are copied
156+
# directly to the root of the documentation.
157+
#html_extra_path = []
158+
159+
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
160+
# using the given strftime format.
161+
#html_last_updated_fmt = '%b %d, %Y'
162+
163+
# If true, SmartyPants will be used to convert quotes and dashes to
164+
# typographically correct entities.
165+
#html_use_smartypants = True
166+
167+
# Custom sidebar templates, maps document names to template names.
168+
#html_sidebars = {}
169+
170+
# Additional templates that should be rendered to pages, maps page names to
171+
# template names.
172+
#html_additional_pages = {}
173+
174+
# If false, no module index is generated.
175+
#html_domain_indices = True
176+
177+
# If false, no index is generated.
178+
#html_use_index = True
179+
180+
# If true, the index is split into individual pages for each letter.
181+
#html_split_index = False
182+
183+
# If true, links to the reST sources are added to the pages.
184+
#html_show_sourcelink = True
185+
186+
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
187+
#html_show_sphinx = True
188+
189+
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
190+
#html_show_copyright = True
191+
192+
# If true, an OpenSearch description file will be output, and all pages will
193+
# contain a <link> tag referring to it. The value of this option must be the
194+
# base URL from which the finished HTML is served.
195+
#html_use_opensearch = ''
196+
197+
# This is the file name suffix for HTML files (e.g. ".xhtml").
198+
#html_file_suffix = None
199+
200+
# Language to be used for generating the HTML full-text search index.
201+
# Sphinx supports the following languages:
202+
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
203+
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
204+
#html_search_language = 'en'
205+
206+
# A dictionary with options for the search language support, empty by default.
207+
# Now only 'ja' uses this config value
208+
#html_search_options = {'type': 'default'}
209+
210+
# The name of a javascript file (relative to the configuration directory) that
211+
# implements a search results scorer. If empty, the default will be used.
212+
#html_search_scorer = 'scorer.js'
213+
214+
# Output file base name for HTML help builder.
215+
htmlhelp_basename = 'google-cloud-error-reporting-doc'
216+
217+
# -- Options for LaTeX output ---------------------------------------------
218+
219+
latex_elements = {
220+
# The paper size ('letterpaper' or 'a4paper').
221+
#'papersize': 'letterpaper',
222+
223+
# The font size ('10pt', '11pt' or '12pt').
224+
#'pointsize': '10pt',
225+
226+
# Additional stuff for the LaTeX preamble.
227+
#'preamble': '',
228+
229+
# Latex figure (float) alignment
230+
#'figure_align': 'htbp',
231+
}
232+
233+
# Grouping the document tree into LaTeX files. List of tuples
234+
# (source start file, target name, title,
235+
# author, documentclass [howto, manual, or own class]).
236+
latex_documents = [
237+
(master_doc, 'google-cloud-error-reporting.tex',
238+
u'google-cloud-error-reporting Documentation', author, 'manual'),
239+
]
240+
241+
# The name of an image file (relative to this directory) to place at the top of
242+
# the title page.
243+
#latex_logo = None
244+
245+
# For "manual" documents, if this is true, then toplevel headings are parts,
246+
# not chapters.
247+
#latex_use_parts = False
248+
249+
# If true, show page references after internal links.
250+
#latex_show_pagerefs = False
251+
252+
# If true, show URL addresses after external links.
253+
#latex_show_urls = False
254+
255+
# Documents to append as an appendix to all manuals.
256+
#latex_appendices = []
257+
258+
# If false, no module index is generated.
259+
#latex_domain_indices = True
260+
261+
# -- Options for manual page output ---------------------------------------
262+
263+
# One entry per manual page. List of tuples
264+
# (source start file, name, description, authors, manual section).
265+
man_pages = [(master_doc, 'google-cloud-error-reporting',
266+
u'google-cloud-error-reporting Documentation', [author], 1)]
267+
268+
# If true, show URL addresses after external links.
269+
#man_show_urls = False
270+
271+
# -- Options for Texinfo output -------------------------------------------
272+
273+
# Grouping the document tree into Texinfo files. List of tuples
274+
# (source start file, target name, title, author,
275+
# dir menu entry, description, category)
276+
texinfo_documents = [
277+
(master_doc, 'google-cloud-error-reporting',
278+
u'google-cloud-error-reporting Documentation', author,
279+
'google-cloud-error-reporting',
280+
'GAPIC library for the {metadata.shortName} v1beta1 service', 'APIs'),
281+
]
282+
283+
# Documents to append as an appendix to all manuals.
284+
#texinfo_appendices = []
285+
286+
# If false, no module index is generated.
287+
#texinfo_domain_indices = True
288+
289+
# How to display URL addresses: 'footnote', 'no', or 'inline'.
290+
#texinfo_show_urls = 'footnote'
291+
292+
# If true, do not generate a @detailmenu in the "Top" node's menu.
293+
#texinfo_no_detailmenu = False
294+
295+
# Example configuration for intersphinx: refer to the Python standard library.
296+
intersphinx_mapping = {
297+
'python': ('http://python.readthedocs.org/en/latest/', None),
298+
'gax': ('https://gax-python.readthedocs.org/en/latest/', None),
299+
}
300+
301+
# Napoleon settings
302+
napoleon_google_docstring = True
303+
napoleon_numpy_docstring = True
304+
napoleon_include_private_with_doc = False
305+
napoleon_include_special_with_doc = True
306+
napoleon_use_admonition_for_examples = False
307+
napoleon_use_admonition_for_notes = False
308+
napoleon_use_admonition_for_references = False
309+
napoleon_use_ivar = False
310+
napoleon_use_param = True
311+
napoleon_use_rtype = True

docs/gapic/v1beta1/api.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Client for Stackdriver Error Reporting API
2+
==========================================
3+
4+
.. automodule:: google.cloud.errorreporting_v1beta1
5+
:members:
6+
:inherited-members:

docs/gapic/v1beta1/types.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Types for Stackdriver Error Reporting API Client
2+
================================================
3+
4+
.. automodule:: google.cloud.errorreporting_v1beta1.types
5+
:members:

0 commit comments

Comments
 (0)