Add sphinx-driven docs

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+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).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/api.rst

@@ -0,0 +1,55 @@
+API
+===
+
+Solvers
+-------
+
+.. automodule:: lrl.solvers
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+.. autoclass:: lrl.solvers.BaseSolver
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+Environments
+------------
+
+.. automodule:: lrl.environments
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+Experiment Runners
+------------------
+
+.. automodule:: lrl.utils.experiment_runners
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+Plotting
+--------
+
+.. automodule:: lrl.utils.plotting
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+Data Stores
+-----------
+
+.. automodule:: lrl.data_stores
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+Miscellaneous Utilities
+-----------------------
+
+.. automodule:: lrl.utils.misc
+   :members:
+   :show-inheritance:
+   :inherited-members:

docs/source/conf.py

@@ -0,0 +1,74 @@
+# 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
+sys.path.insert(0, os.path.abspath('../../'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'lrl'
+copyright = '2019, Andrew Scribner'
+author = 'Andrew Scribner'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+autodoc_default_options = {
+    # 'members':         True,
+    'member-order':    'bysource',
+    # Includes just the __init__ 'special' (__member__) by default because we
+    # have a single callout (True would have included all by default?)
+    # 'special-members': '__init__',  
+}
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'recommonmark',  # Not sure why I have this.  Supports .md and .rst in same 00docs?
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'lrl.utils.sphinx_ext',  # Custom extension that makes it easier to doc local __special__
+    'nbsphinx',  # Enable linking to ipynb to show examples
+    'sphinx.ext.mathjax',
+]
+
+# 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', '**.ipynb_checkpoints']
+
+
+# -- 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'
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+    'collapse_navigation': False,
+    'sticky_navigation': True,
+}
+
+# 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']