Add proper documentation using Sphinx. (Closes #9)

jsmidt · Mar 8, 2013 · 4c5868e · 4c5868e
1 parent 7d8fc18
commit 4c5868e
Show file tree

Hide file tree

Showing 54 changed files with 7 additions and 3,913 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
 *pyc
 *swp
-build/
-sphinx/_*
+docs/_build
+
diff --git a/README.md b/README.md
@@ -14,6 +14,11 @@ Some current capabilities:
    * Calculation of optimal weights for Sharpe ratio and efficient frontier
    * Bare bones event profiler
 
+Documentation:
+--------------
+
+The main documentation can be read at [Read The Docs](https://quantpy.readthedocs.org/en/latest/).  Please start their for more information.
+
 Contributions Welcome.
 ----------------------
 

diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/getting_started.doctree b/docs/_build/doctrees/getting_started.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/examples/efficient_frontier_plot_ex.hires.png b/docs/_build/examples/efficient_frontier_plot_ex.hires.png
diff --git a/docs/_build/examples/efficient_frontier_plot_ex.pdf b/docs/_build/examples/efficient_frontier_plot_ex.pdf
diff --git a/docs/_build/examples/efficient_frontier_plot_ex.png b/docs/_build/examples/efficient_frontier_plot_ex.png
diff --git a/docs/_build/examples/efficient_frontier_plot_ex.py b/docs/_build/examples/efficient_frontier_plot_ex.py
diff --git a/docs/_build/examples/event_ex.hires.png b/docs/_build/examples/event_ex.hires.png
diff --git a/docs/_build/examples/event_ex.pdf b/docs/_build/examples/event_ex.pdf
diff --git a/docs/_build/examples/event_ex.png b/docs/_build/examples/event_ex.png
diff --git a/docs/_build/examples/event_ex.py b/docs/_build/examples/event_ex.py
diff --git a/docs/_build/examples/min_variance_returns_ex.hires.png b/docs/_build/examples/min_variance_returns_ex.hires.png
diff --git a/docs/_build/examples/min_variance_returns_ex.pdf b/docs/_build/examples/min_variance_returns_ex.pdf
diff --git a/docs/_build/examples/min_variance_returns_ex.png b/docs/_build/examples/min_variance_returns_ex.png
diff --git a/docs/_build/examples/min_variance_returns_ex.py b/docs/_build/examples/min_variance_returns_ex.py
diff --git a/docs/_build/examples/nplot_ex.hires.png b/docs/_build/examples/nplot_ex.hires.png
diff --git a/docs/_build/examples/nplot_ex.pdf b/docs/_build/examples/nplot_ex.pdf
diff --git a/docs/_build/examples/nplot_ex.png b/docs/_build/examples/nplot_ex.png
diff --git a/docs/_build/examples/nplot_ex.py b/docs/_build/examples/nplot_ex.py
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
diff --git a/docs/_build/html/_images/efficient_frontier_plot_ex.png b/docs/_build/html/_images/efficient_frontier_plot_ex.png
diff --git a/docs/_build/html/_images/event_ex.png b/docs/_build/html/_images/event_ex.png
diff --git a/docs/_build/html/_images/min_variance_returns_ex.png b/docs/_build/html/_images/min_variance_returns_ex.png
diff --git a/docs/_build/html/_images/nplot_ex.png b/docs/_build/html/_images/nplot_ex.png
diff --git a/docs/_build/html/_sources/getting_started.txt b/docs/_build/html/_sources/getting_started.txt
diff --git a/docs/_build/html/_sources/index.txt b/docs/_build/html/_sources/index.txt
diff --git a/docs/_build/html/_static/ajax-loader.gif b/docs/_build/html/_static/ajax-loader.gif