This commit is contained in:
Sean Whalen
2018-10-12 14:18:53 -04:00
parent 906b9c7d70
commit d73cdfaed4
2 changed files with 21 additions and 1 deletions

View File

@@ -1026,9 +1026,17 @@ parsedmarc.elastic
.. automodule:: parsedmarc.elastic
:members:
.. toctree::
:maxdepth: 2
:caption: Contents:
.. automodule:: parsedmarc.splunk
:members:
.. toctree::
:maxdepth: 2
:caption: Contents:
.. automodule:: parsedmarc.utils
:members:
@@ -1036,6 +1044,10 @@ parsedmarc.elastic
:maxdepth: 2
:caption: Contents:
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================

View File

@@ -123,7 +123,9 @@
<li><a class="reference internal" href="#dmarc-alignment-guide">DMARC Alignment Guide</a></li>
<li><a class="reference internal" href="#what-if-a-sender-won-t-support-dkim-dmarc">What if a sender wont support DKIM/DMARC?</a></li>
<li><a class="reference internal" href="#module-parsedmarc">API</a><ul>
<li><a class="reference internal" href="#module-parsedmarc.elastic">parsedmarc.elastic</a></li>
<li><a class="reference internal" href="#module-parsedmarc.elastic">parsedmarc.elastic</a><ul>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
@@ -1526,6 +1528,8 @@ to a callback function</p>
</table>
</dd></dl>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-parsedmarc.splunk"></span><dl class="class">
<dt id="parsedmarc.splunk.HECClient">
<em class="property">class </em><code class="descclassname">parsedmarc.splunk.</code><code class="descname">HECClient</code><span class="sig-paren">(</span><em>url</em>, <em>access_token</em>, <em>index</em>, <em>source='parsedmarc'</em>, <em>verify=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/parsedmarc/splunk.html#HECClient"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#parsedmarc.splunk.HECClient" title="Permalink to this definition"></a></dt>
@@ -1574,6 +1578,8 @@ to a callback function</p>
<dd><p>Raised when a Splunk API error occurs</p>
</dd></dl>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-parsedmarc.utils"></span><p>Utility functions that might be useful for other projects</p>
<dl class="exception">
<dt id="parsedmarc.utils.EmailParserError">
@@ -1850,6 +1856,8 @@ country associated with the given IPv4 or IPv6 address</p>
</table>
</dd></dl>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
</div>