Add initial sphinx docs (#114)

Makefile

@@ -1,8 +1,13 @@
-all: test
+.PHONY: all install docs lint format test clean FORCE
+
+all: docs test
 
 install:
 	pip install -e .[dev]
 
+docs: FORCE
+	$(MAKE) -C docs html
+
 lint: FORCE
 	flake8
 
@@ -23,6 +28,6 @@ test: lint FORCE
 	@echo PASS
 
 clean: FORCE
-	git clean -dfx -e pyro-egg.info
+	git clean -dfx -e funsor-egg.info
 
 FORCE:

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = funsor
+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,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=funsor
+
+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%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/source/adjoint.rst

@@ -0,0 +1,7 @@
+Adjoint Algorithms
+------------------
+.. automodule:: funsor.adjoint
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource

docs/source/conf.py

@@ -0,0 +1,190 @@
+import os
+import sys
+
+import sphinx_rtd_theme
+
+
+# import pkg_resources
+
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain 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.
+#
+sys.path.insert(0, os.path.abspath('../..'))
+
+# -- Project information -----------------------------------------------------
+
+project = u'Funsor'
+copyright = u'2019, Uber Technologies, Inc'
+author = u'Uber AI Labs'
+
+# The short X.Y version
+version = u'0.0'
+# The full version, including alpha/beta/rc tags
+release = u'0.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# 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
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.viewcode',
+]
+
+# Disable documentation inheritance so as to avoid inheriting
+# docstrings in a different format, e.g. when the parent class
+# is a PyTorch class.
+
+autodoc_inherit_docstrings = False
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# 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 = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# do not prepend module name to functions
+add_module_names = False
+
+# -- 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 = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'funsordoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# 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 = [
+    (master_doc, 'Funsor.tex', u'Funsor Documentation', u'Uber AI Labs', 'manual'),
+]
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'Funsor', u'Funsor Documentation',
+     [author], 1)
+]
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Funsor', u'Funsor Documentation',
+     author, 'Funsor', 'Functional analysis + tensors + symbolic algebra.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'numpy': ('http://docs.scipy.org/doc/numpy/', None),
+    'torch': ('http://pytorch.org/docs/master/', None),
+    'pyro': ('http://docs.pyro.ai/en/stable/', None),
+    'opt_einsum': ('https://optimized-einsum.readthedocs.io/en/stable/', None)
+}
+
+# @jpchen's hack to get rtd builder to install latest pytorch
+if 'READTHEDOCS' in os.environ:
+    os.system('pip install https://download.pytorch.org/whl/cpu/torch-1.0.0-cp27-cp27mu-linux_x86_64.whl')

docs/source/distributions.rst

@@ -0,0 +1,7 @@
+Distributions
+-------------
+.. automodule:: funsor.distributions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource

docs/source/domains.rst

@@ -0,0 +1,7 @@
+Domains
+-------
+.. automodule:: funsor.domains
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource

docs/source/einsum.rst

@@ -0,0 +1,7 @@
+Einsum Interface
+----------------
+.. automodule:: funsor.einsum
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource

docs/source/funsors.rst

@@ -0,0 +1,58 @@
+Funsors
+=======
+
+Basic Funsors
+-------------
+.. automodule:: funsor.terms
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource
+
+Delta
+-----
+.. automodule:: funsor.delta
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource
+
+PyTorch
+-------
+.. automodule:: funsor.torch
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource
+
+NumPy
+-----
+.. automodule:: funsor.numpy
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource
+
+Gaussian
+--------
+.. automodule:: funsor.gaussian
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource
+
+Contract
+--------
+.. automodule:: funsor.contract
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource
+
+Integrate
+---------
+.. automodule:: funsor.integrate
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource