From 84f64a23943c3ca80e1f741ff62245dfe9862e28 Mon Sep 17 00:00:00 2001
From: "Nick L. Petroni, Jr" <npetroni@volexity.com>
Date: Thu, 18 Aug 2016 17:01:09 -0400
Subject: [PATCH] doc: auto-generate files and cleanup syntax

---
 doc/Makefile           | 11 +++++++++--
 doc/source/conf.py     |  2 +-
 doc/source/index.rst   | 25 ++++++++++++++++---------
 doc/source/modules.rst |  7 -------
 4 files changed, 26 insertions(+), 19 deletions(-)
 delete mode 100644 doc/source/modules.rst

diff --git a/doc/Makefile b/doc/Makefile
index 70c5082ca..3579955a6 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -19,7 +19,7 @@ ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) sou
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+.PHONY: genfiles help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
@@ -46,10 +46,17 @@ help:
 	@echo "  linkcheck  to check all external links for integrity"
 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 
+source/volatility.rst:
+	$(MAKE) genfiles
+
+genfiles:
+	sphinx-apidoc -e -T -f -o source ../volatility
+
 clean:
 	rm -rf $(BUILDDIR)/*
+	rm -f source/volatility*.rst
 
-html:
+html: source/volatility.rst
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 9f040ee8c..7a1d73eee 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -18,7 +18,7 @@ import os
 # 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.
-sys.path.insert(0, os.path.abspath('../../volatility'))
+sys.path.insert(0, os.path.abspath('../..'))
 
 # -- General configuration ------------------------------------------------
 
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 9e2ce5345..ce073f0a5 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,17 +1,24 @@
-.. 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.
+Volatility 3
+============
 
-Welcome to Volatility's documentation!
-======================================
+This is the documentation for Volatility 3, the most advanced memory forensics
+framework in the world. Like previous versions of the Volatility framework,
+Volatility 3 is Open Source.
 
-Contents:
+Python Packages
+===============
 
 .. toctree::
-:maxdepth: 2
+    :hidden:
 
-       modules.rst
+    volatility
+
+.. toctree::
+    :maxdepth: 1
+
+    volatility.cli
+    volatility.framework
+    volatility.plugins
 
 Indices and tables
 ==================
diff --git a/doc/source/modules.rst b/doc/source/modules.rst
deleted file mode 100644
index 9c451fcf0..000000000
--- a/doc/source/modules.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-volatility
-==========
-
-.. toctree::
-:maxdepth: 4
-
-       volatility