Add additional docstrings and refactor/rearrange the entire codebase.

doc/source/conf.py

@@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../../volatility'))
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -189,22 +189,22 @@ htmlhelp_basename = 'Volatilitydoc'
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    #'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    #'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    #'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'Volatility.tex', u'Volatility Documentation',
-   u'Volatility Foundation', 'manual'),
+    ('index', 'Volatility.tex', u'Volatility Documentation',
+     u'Volatility Foundation', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -247,9 +247,9 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'Volatility', u'Volatility Documentation',
-   u'Volatility Foundation', 'Volatility', 'One line description of project.',
-   'Miscellaneous'),
+    ('index', 'Volatility', u'Volatility Documentation',
+     u'Volatility Foundation', 'Volatility', 'One line description of project.',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.

doc/source/index.rst

@@ -1,7 +1,7 @@
 .. Volatility documentation master file, created by
-   sphinx-quickstart on Wed Apr  2 01:48:22 2014.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+sphinx-quickstart on Wed Apr  2 01:48:22 2014.
+You can adapt this file completely to your liking, but it should at least
+contain the root `toctree` directive.
 
 Welcome to Volatility's documentation!
 ======================================
@@ -9,9 +9,9 @@ Welcome to Volatility's documentation!
 Contents:
 
 .. toctree::
-   :maxdepth: 2
+:maxdepth: 2
 
-   modules.rst
+       modules.rst
 
 Indices and tables
 ==================

doc/source/modules.rst

@@ -2,6 +2,6 @@ volatility
 ==========
 
 .. toctree::
-   :maxdepth: 4
+:maxdepth: 4
 
-   volatility
+       volatility