Skip to content

Commit ecf7288

Browse files
vhenonvhenon
committed
Update doc
1 parent a1fe622 commit ecf7288

9 files changed

Lines changed: 510 additions & 107 deletions

File tree

‎docs/_sources/index.rst.txt‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,16 @@
66
Google Postmaster Domains Datas
77
===================================================
88

9+
.. automodule:: googlepostmasterapi.logger
10+
:members:
11+
:exclude-members: verbose
12+
13+
.. automodule:: googlepostmasterapi.base
14+
:members:
15+
916
.. automodule:: googlepostmasterapi.gpt
1017
:members:
11-
:exclude-members: MODULE_PATH, verbose
18+
:exclude-members: MODULE_PATH
1219

1320
.. automodule:: googlepostmasterapi.data
1421
:members:
@@ -18,9 +25,6 @@ Google Postmaster Domains Datas
1825
:members:
1926
:exclude-members: MODULE_PATH
2027

21-
.. automodule:: googlepostmasterapi.utils
22-
:members:
23-
2428
.. toctree::
2529
:maxdepth: 2
2630
:caption: Contents:

‎docs/_static/documentation_options.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '0.2.0',
2+
VERSION: '0.2.2',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

‎docs/genindex.html‎

Lines changed: 95 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Index &mdash; Google Postmaster Domains Data 0.2.0 documentation</title>
8+
<title>Index &mdash; Google Postmaster Domains Data 0.2.2 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
1010
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
1111

1212

1313
<script src="_static/jquery.js?v=5d32c60e"></script>
1414
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15-
<script src="_static/documentation_options.js?v=938c9ccc"></script>
15+
<script src="_static/documentation_options.js?v=000c92bf"></script>
1616
<script src="_static/doctools.js?v=fd6eb6e6"></script>
1717
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
1818
<script src="_static/js/theme.js"></script>
@@ -70,14 +70,15 @@ <h1 id="index">Index</h1>
7070
<div class="genindex-jumpbox">
7171
<a href="#_"><strong>_</strong></a>
7272
| <a href="#A"><strong>A</strong></a>
73+
| <a href="#B"><strong>B</strong></a>
7374
| <a href="#C"><strong>C</strong></a>
7475
| <a href="#D"><strong>D</strong></a>
7576
| <a href="#E"><strong>E</strong></a>
7677
| <a href="#F"><strong>F</strong></a>
7778
| <a href="#G"><strong>G</strong></a>
79+
| <a href="#L"><strong>L</strong></a>
7880
| <a href="#M"><strong>M</strong></a>
7981
| <a href="#P"><strong>P</strong></a>
80-
| <a href="#R"><strong>R</strong></a>
8182
| <a href="#S"><strong>S</strong></a>
8283
| <a href="#V"><strong>V</strong></a>
8384
| <a href="#W"><strong>W</strong></a>
@@ -86,10 +87,16 @@ <h1 id="index">Index</h1>
8687
<h2 id="_">_</h2>
8788
<table style="width: 100%" class="indextable genindextable"><tr>
8889
<td style="width: 33%; vertical-align: top;"><ul>
89-
<li><a href="index.html#googlepostmasterapi.data.FlatData.__init__">__init__() (googlepostmasterapi.data.FlatData method)</a>
90+
<li><a href="index.html#googlepostmasterapi.base.Base.__init__">__init__() (googlepostmasterapi.base.Base method)</a>
9091

9192
<ul>
93+
<li><a href="index.html#googlepostmasterapi.data.FlatData.__init__">(googlepostmasterapi.data.FlatData method)</a>
94+
</li>
9295
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster.__init__">(googlepostmasterapi.gpt.GPostmaster method)</a>
96+
</li>
97+
<li><a href="index.html#googlepostmasterapi.logger.Logger.__init__">(googlepostmasterapi.logger.Logger method)</a>
98+
</li>
99+
<li><a href="index.html#googlepostmasterapi.logger.LoggingFilter.__init__">(googlepostmasterapi.logger.LoggingFilter method)</a>
93100
</li>
94101
<li><a href="index.html#googlepostmasterapi.stats.Stats.__init__">(googlepostmasterapi.stats.Stats method)</a>
95102
</li>
@@ -107,6 +114,8 @@ <h2 id="_">_</h2>
107114
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._create_domain_uri">_create_domain_uri() (googlepostmasterapi.gpt.GPostmaster method)</a>
108115
</li>
109116
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._create_fbl_metric_definitions">_create_fbl_metric_definitions() (googlepostmasterapi.gpt.GPostmaster method)</a>
117+
</li>
118+
<li><a href="index.html#googlepostmasterapi.logger.Logger._create_log_tpl">_create_log_tpl() (googlepostmasterapi.logger.Logger method)</a>
110119
</li>
111120
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._create_metric_definitions">_create_metric_definitions() (googlepostmasterapi.gpt.GPostmaster method)</a>
112121
</li>
@@ -121,6 +130,8 @@ <h2 id="_">_</h2>
121130
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._domains">_domains (googlepostmasterapi.gpt.GPostmaster attribute)</a>
122131
</li>
123132
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._extract_fbl_ids">_extract_fbl_ids() (googlepostmasterapi.gpt.GPostmaster method)</a>
133+
</li>
134+
<li><a href="index.html#googlepostmasterapi.logger.Logger._get_current_class_name">_get_current_class_name() (googlepostmasterapi.logger.Logger method)</a>
124135
</li>
125136
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._get_domain_infos_pool">_get_domain_infos_pool() (googlepostmasterapi.gpt.GPostmaster method)</a>
126137
</li>
@@ -132,23 +143,47 @@ <h2 id="_">_</h2>
132143
</li>
133144
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._gpt_get_domain_verify_token">_gpt_get_domain_verify_token() (googlepostmasterapi.gpt.GPostmaster method)</a>
134145
</li>
135-
</ul></td>
136-
<td style="width: 33%; vertical-align: top;"><ul>
137146
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._gpt_get_domains">_gpt_get_domains() (googlepostmasterapi.gpt.GPostmaster method)</a>
138147
</li>
139148
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._gpt_verify_domain">_gpt_verify_domain() (googlepostmasterapi.gpt.GPostmaster method)</a>
140149
</li>
141150
<li><a href="index.html#googlepostmasterapi.data.FlatData._index_domain_stats">_index_domain_stats() (googlepostmasterapi.data.FlatData method)</a>
151+
</li>
152+
<li><a href="index.html#googlepostmasterapi.logger.Logger._init_logger">_init_logger() (googlepostmasterapi.logger.Logger method)</a>
153+
</li>
154+
</ul></td>
155+
<td style="width: 33%; vertical-align: top;"><ul>
156+
<li><a href="index.html#googlepostmasterapi.logger.Logger._init_logger_format">_init_logger_format() (googlepostmasterapi.logger.Logger method)</a>
157+
</li>
158+
<li><a href="index.html#googlepostmasterapi.logger.Logger._init_logger_stderr">_init_logger_stderr() (googlepostmasterapi.logger.Logger method)</a>
159+
</li>
160+
<li><a href="index.html#googlepostmasterapi.logger.Logger._init_logger_stdout">_init_logger_stdout() (googlepostmasterapi.logger.Logger method)</a>
142161
</li>
143162
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._init_parser_con">_init_parser_con() (googlepostmasterapi.gpt.GPostmaster method)</a>
144163
</li>
145164
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._init_resources">_init_resources() (googlepostmasterapi.gpt.GPostmaster method)</a>
165+
</li>
166+
<li><a href="index.html#googlepostmasterapi.logger.Logger._init_resources_logger">_init_resources_logger() (googlepostmasterapi.logger.Logger method)</a>
146167
</li>
147168
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._init_service">_init_service() (googlepostmasterapi.gpt.GPostmaster method)</a>
148169
</li>
149170
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._init_stats_con">_init_stats_con() (googlepostmasterapi.gpt.GPostmaster method)</a>
150171
</li>
151172
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._load_token">_load_token() (googlepostmasterapi.gpt.GPostmaster method)</a>
173+
</li>
174+
<li><a href="index.html#googlepostmasterapi.logger.Logger._log_add_filter">_log_add_filter() (googlepostmasterapi.logger.Logger method)</a>
175+
</li>
176+
<li><a href="index.html#googlepostmasterapi.logger.Logger._log_add_handler">_log_add_handler() (googlepostmasterapi.logger.Logger method)</a>
177+
</li>
178+
<li><a href="index.html#googlepostmasterapi.logger.Logger._log_get_logger">_log_get_logger() (googlepostmasterapi.logger.Logger method)</a>
179+
</li>
180+
<li><a href="index.html#googlepostmasterapi.logger.Logger._log_set_format">_log_set_format() (googlepostmasterapi.logger.Logger method)</a>
181+
</li>
182+
<li><a href="index.html#googlepostmasterapi.logger.Logger._log_set_level">_log_set_level() (googlepostmasterapi.logger.Logger method)</a>
183+
</li>
184+
<li><a href="index.html#googlepostmasterapi.logger.Logger._log_tpl">_log_tpl (googlepostmasterapi.logger.Logger attribute)</a>
185+
</li>
186+
<li><a href="index.html#googlepostmasterapi.logger.Logger._logger">_logger (googlepostmasterapi.logger.Logger attribute)</a>
152187
</li>
153188
<li><a href="index.html#googlepostmasterapi.data.FlatData._parse_crypted_inbound">_parse_crypted_inbound() (googlepostmasterapi.data.FlatData method)</a>
154189
</li>
@@ -171,6 +206,8 @@ <h2 id="_">_</h2>
171206
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._print_stats">_print_stats() (googlepostmasterapi.gpt.GPostmaster method)</a>
172207
</li>
173208
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._query_domain_stats">_query_domain_stats() (googlepostmasterapi.gpt.GPostmaster method)</a>
209+
</li>
210+
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._recursive_call">_recursive_call() (googlepostmasterapi.gpt.GPostmaster method)</a>
174211
</li>
175212
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster._service">_service (googlepostmasterapi.gpt.GPostmaster attribute)</a>
176213
</li>
@@ -197,6 +234,14 @@ <h2 id="A">A</h2>
197234
</ul></td>
198235
</tr></table>
199236

237+
<h2 id="B">B</h2>
238+
<table style="width: 100%" class="indextable genindextable"><tr>
239+
<td style="width: 33%; vertical-align: top;"><ul>
240+
<li><a href="index.html#googlepostmasterapi.base.Base">Base (class in googlepostmasterapi.base)</a>
241+
</li>
242+
</ul></td>
243+
</tr></table>
244+
200245
<h2 id="C">C</h2>
201246
<table style="width: 100%" class="indextable genindextable"><tr>
202247
<td style="width: 33%; vertical-align: top;"><ul>
@@ -220,13 +265,17 @@ <h2 id="D">D</h2>
220265
<h2 id="E">E</h2>
221266
<table style="width: 100%" class="indextable genindextable"><tr>
222267
<td style="width: 33%; vertical-align: top;"><ul>
223-
<li><a href="index.html#googlepostmasterapi.utils.extract_stat_value">extract_stat_value() (in module googlepostmasterapi.utils)</a>
268+
<li><a href="index.html#googlepostmasterapi.base.Base.extract_stat_value">extract_stat_value() (googlepostmasterapi.base.Base method)</a>
224269
</li>
225270
</ul></td>
226271
</tr></table>
227272

228273
<h2 id="F">F</h2>
229274
<table style="width: 100%" class="indextable genindextable"><tr>
275+
<td style="width: 33%; vertical-align: top;"><ul>
276+
<li><a href="index.html#googlepostmasterapi.logger.LoggingFilter.filter">filter() (googlepostmasterapi.logger.LoggingFilter method)</a>
277+
</li>
278+
</ul></td>
230279
<td style="width: 33%; vertical-align: top;"><ul>
231280
<li><a href="index.html#googlepostmasterapi.data.FlatData">FlatData (class in googlepostmasterapi.data)</a>
232281
</li>
@@ -245,6 +294,13 @@ <h2 id="G">G</h2>
245294
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster.get_domains">get_domains() (googlepostmasterapi.gpt.GPostmaster method)</a>
246295
</li>
247296
<li>
297+
googlepostmasterapi.base
298+
299+
<ul>
300+
<li><a href="index.html#module-googlepostmasterapi.base">module</a>
301+
</li>
302+
</ul></li>
303+
<li>
248304
googlepostmasterapi.data
249305

250306
<ul>
@@ -261,41 +317,61 @@ <h2 id="G">G</h2>
261317
</li>
262318
</ul></li>
263319
<li>
264-
googlepostmasterapi.stats
320+
googlepostmasterapi.logger
265321

266322
<ul>
267-
<li><a href="index.html#module-googlepostmasterapi.stats">module</a>
323+
<li><a href="index.html#module-googlepostmasterapi.logger">module</a>
268324
</li>
269325
</ul></li>
270326
<li>
271-
googlepostmasterapi.utils
327+
googlepostmasterapi.stats
272328

273329
<ul>
274-
<li><a href="index.html#module-googlepostmasterapi.utils">module</a>
330+
<li><a href="index.html#module-googlepostmasterapi.stats">module</a>
275331
</li>
276332
</ul></li>
277333
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster">GPostmaster (class in googlepostmasterapi.gpt)</a>
278334
</li>
279335
</ul></td>
280336
</tr></table>
281337

338+
<h2 id="L">L</h2>
339+
<table style="width: 100%" class="indextable genindextable"><tr>
340+
<td style="width: 33%; vertical-align: top;"><ul>
341+
<li><a href="index.html#googlepostmasterapi.logger.Logger">Logger (class in googlepostmasterapi.logger)</a>
342+
</li>
343+
</ul></td>
344+
<td style="width: 33%; vertical-align: top;"><ul>
345+
<li><a href="index.html#googlepostmasterapi.logger.LoggingFilter">LoggingFilter (class in googlepostmasterapi.logger)</a>
346+
</li>
347+
</ul></td>
348+
</tr></table>
349+
282350
<h2 id="M">M</h2>
283351
<table style="width: 100%" class="indextable genindextable"><tr>
284352
<td style="width: 33%; vertical-align: top;"><ul>
353+
<li><a href="index.html#googlepostmasterapi.logger.LoggingFilter.max_level">max_level (googlepostmasterapi.logger.LoggingFilter attribute)</a>
354+
</li>
285355
<li>
286356
module
287357

288358
<ul>
359+
<li><a href="index.html#module-googlepostmasterapi.base">googlepostmasterapi.base</a>
360+
</li>
289361
<li><a href="index.html#module-googlepostmasterapi.data">googlepostmasterapi.data</a>
290362
</li>
291363
<li><a href="index.html#module-googlepostmasterapi.gpt">googlepostmasterapi.gpt</a>
292364
</li>
293-
<li><a href="index.html#module-googlepostmasterapi.stats">googlepostmasterapi.stats</a>
365+
<li><a href="index.html#module-googlepostmasterapi.logger">googlepostmasterapi.logger</a>
294366
</li>
295-
<li><a href="index.html#module-googlepostmasterapi.utils">googlepostmasterapi.utils</a>
367+
<li><a href="index.html#module-googlepostmasterapi.stats">googlepostmasterapi.stats</a>
296368
</li>
297369
</ul></li>
298370
</ul></td>
371+
<td style="width: 33%; vertical-align: top;"><ul>
372+
<li><a href="index.html#googlepostmasterapi.base.MODULE_PATH">MODULE_PATH (in module googlepostmasterapi.base)</a>
373+
</li>
374+
</ul></td>
299375
</tr></table>
300376

301377
<h2 id="P">P</h2>
@@ -310,14 +386,6 @@ <h2 id="P">P</h2>
310386
</ul></td>
311387
</tr></table>
312388

313-
<h2 id="R">R</h2>
314-
<table style="width: 100%" class="indextable genindextable"><tr>
315-
<td style="width: 33%; vertical-align: top;"><ul>
316-
<li><a href="index.html#googlepostmasterapi.utils.recursive_call">recursive_call() (in module googlepostmasterapi.utils)</a>
317-
</li>
318-
</ul></td>
319-
</tr></table>
320-
321389
<h2 id="S">S</h2>
322390
<table style="width: 100%" class="indextable genindextable"><tr>
323391
<td style="width: 33%; vertical-align: top;"><ul>
@@ -333,7 +401,7 @@ <h2 id="S">S</h2>
333401
<h2 id="V">V</h2>
334402
<table style="width: 100%" class="indextable genindextable"><tr>
335403
<td style="width: 33%; vertical-align: top;"><ul>
336-
<li><a href="index.html#googlepostmasterapi.gpt.GPostmaster.verbose">verbose (googlepostmasterapi.gpt.GPostmaster attribute)</a>
404+
<li><a href="index.html#googlepostmasterapi.logger.Logger.verbose">verbose (googlepostmasterapi.logger.Logger attribute)</a>
337405
</li>
338406
</ul></td>
339407
<td style="width: 33%; vertical-align: top;"><ul>
@@ -345,7 +413,11 @@ <h2 id="V">V</h2>
345413
<h2 id="W">W</h2>
346414
<table style="width: 100%" class="indextable genindextable"><tr>
347415
<td style="width: 33%; vertical-align: top;"><ul>
348-
<li><a href="index.html#googlepostmasterapi.utils.write_std">write_std() (in module googlepostmasterapi.utils)</a>
416+
<li><a href="index.html#googlepostmasterapi.logger.Logger.write_error">write_error() (googlepostmasterapi.logger.Logger method)</a>
417+
</li>
418+
</ul></td>
419+
<td style="width: 33%; vertical-align: top;"><ul>
420+
<li><a href="index.html#googlepostmasterapi.logger.Logger.write_log">write_log() (googlepostmasterapi.logger.Logger method)</a>
349421
</li>
350422
</ul></td>
351423
</tr></table>

0 commit comments

Comments
 (0)