Added docs

docs/Makefile

@@ -0,0 +1,23 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+html: Makefile
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+epub: Makefile
+	@$(SPHINXBUILD) -M epub "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,66 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+import datetime
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- Project information -----------------------------------------------------
+
+project = 'Python Forensics Handbook'
+copyright = '2019, Chapin Bryce'
+author = 'Chapin Bryce'
+
+# The full version, including alpha/beta/rc tags
+release = datetime.datetime.now().strftime('%Y%m%d')
+version = datetime.datetime.now().strftime('%Y%m%d')
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    # 'sphinx.ext.viewcode',
+    'sphinx.ext.autodoc', 'sphinx.ext.napoleon'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+## Added by CBRYCE
+
+# Hide module names in docs
+add_module_names = False
+
+# Allow extensions to work in epub
+viewcode_enable_epub = True

docs/index.rst

@@ -0,0 +1,28 @@
+.. Python Forensics Handbook documentation master file, created by
+   sphinx-quickstart on Tue May 28 07:12:54 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+The Python Forensics Handbook
+=============================
+---------------------------------------------
+A guide for developing Python scripts in DFIR
+---------------------------------------------
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   section1
+
+Handbook Sections
+==============================
+.. automodule:: sections
+   :members:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/section1.rst

@@ -0,0 +1,32 @@
+Section 1 - Essential Scripts
+==============================
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+Section 1.1 - Argparse Example
+==============================
+.. automodule:: sections.section_01.argparse_example
+   :members:
+
+Section 1.2 - Logging Example
+=============================
+.. automodule:: sections.section_01.logging_example
+   :members:
+
+Section 1.3 - CSV Example
+=========================
+.. automodule:: sections.section_01.csv_example
+   :members:
+
+Section 1.4 - Directory Recursion
+=================================
+.. automodule:: sections.section_01.recursion_example
+   :members:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`