Updated doc building

This commit is contained in:
Chapin Bryce 2019-11-03 09:14:27 -05:00
parent 9a75d69878
commit 53ff7a1f2e
10 changed files with 59 additions and 10 deletions

View File

@ -13,3 +13,10 @@ Section 2.2 - Parsing Hive Values
----------------------------------
.. automodule:: sections.section_02.yarp_ntuser
:members:
Indices and tables
--------------------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -8,3 +8,10 @@ Section 3.1 - Opening an Event Log
----------------------------------
.. automodule:: sections.section_03.open_evtx
:members:
Indices and tables
--------------------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -272,13 +272,6 @@ needed with minimal effort.</p></li>
</dl>
</li>
<li><dl class="simple">
<dt>Counts/Metadata about EVTX container</dt><dd><ul>
<li><p>Get information about the EVTX file</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>Parsing Logins (with types, levels, privs)</dt><dd><ul>
<li><p>Parse out the commonly investigated 4624/4672 events</p></li>
</ul>

File diff suppressed because one or more lines are too long

View File

@ -116,6 +116,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="section2.html">Section 2 - Registry Parsing</a></li>
<li class="toctree-l1"><a class="reference internal" href="section3.html">Section 3 - Windows Event Log Parsing</a></li>
</ul>

View File

@ -35,6 +35,7 @@
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Section 3 - Windows Event Log Parsing" href="section3.html" />
<link rel="prev" title="Section 1 - Essential Scripts" href="section1.html" />
</head>
@ -99,8 +100,10 @@
<li class="toctree-l3"><a class="reference internal" href="#id1">Docstring References</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="section3.html">Section 3 - Windows Event Log Parsing</a></li>
</ul>
@ -365,6 +368,14 @@ to be displayed.</p>
</div>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>
</div>
@ -375,6 +386,8 @@ to be displayed.</p>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="section3.html" class="btn btn-neutral float-right" title="Section 3 - Windows Event Log Parsing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="section1.html" class="btn btn-neutral float-left" title="Section 1 - Essential Scripts" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

View File

@ -93,6 +93,7 @@
<li class="toctree-l3"><a class="reference internal" href="#docstring-references">Docstring References</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</li>
</ul>
@ -165,8 +166,12 @@
</div>
<div class="section" id="module-sections.section_03.open_evtx">
<span id="section-3-1-opening-an-event-log"></span><h2>Section 3.1 - Opening an Event Log<a class="headerlink" href="#module-sections.section_03.open_evtx" title="Permalink to this headline"></a></h2>
<p>Example for opening EVTX files</p>
<p>Demonstrates how to open an EVTX file and get basic details about the event log.</p>
<p>Example for opening EVTX files.</p>
<p>Demonstrates how to open an EVTX file and get basic details about the event log.
This section makes use of python-evtx, a python library for reading event log
files. To install, run <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">python-evtx</span></code>.</p>
<p>Other libraries for parsing these event logs exist and we welcome others to
add snippets that showcase how to make use of them in reading EVTX files.</p>
<p>Example Usage:</p>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">python</span> <span class="pre">open_evtx.py</span> <span class="pre">System.evtx</span></code></p>
@ -216,6 +221,14 @@ common parameters about the file.</p>
</div>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>
</div>

View File

@ -18,6 +18,7 @@ help:
html: Makefile
# @$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html"
cp -r $(BUILDDIR)/html/* ../docs
epub: Makefile
@$(SPHINXBUILD) -M epub "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

View File

@ -13,3 +13,10 @@ Section 2.2 - Parsing Hive Values
----------------------------------
.. automodule:: sections.section_02.yarp_ntuser
:members:
Indices and tables
--------------------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -8,3 +8,10 @@ Section 3.1 - Opening an Event Log
----------------------------------
.. automodule:: sections.section_03.open_evtx
:members:
Indices and tables
--------------------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`