Added simple Sphinx configuration.

Author: Johannes Ballé

.gitignore

@@ -1,4 +1,5 @@
+/docs/_build
 .DS_Store
 *.pyc
 *.so
-*.*~
+*~

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    = tensorflow_compression
+SOURCEDIR     = .
+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/conf.py

@@ -0,0 +1,178 @@
+# -*- 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
+
+from __future__ import unicode_literals
+
+# -- 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 = 'tensorflow_compression'
+copyright = '2018 Google LLC'
+author = 'Johannes Ballé, Sung Jin Hwang, Nick Johnston'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+
+# -- 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.githubpages',
+    'sphinx.ext.napoleon',
+]
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- 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'
+
+# 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 = {
+    'canonical_url': '',
+    'analytics_id': '',
+    'logo_only': False,
+    'display_version': True,
+    'prev_next_buttons_location': 'bottom',
+    'style_external_links': False,
+    # Toc options
+    'collapse_navigation': True,
+    'sticky_navigation': True,
+    'navigation_depth': 4,
+    'includehidden': False,
+    'titles_only': False,
+}
+
+# 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 = 'tensorflow_compressiondoc'
+
+
+# -- 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, 'tensorflow_compression.tex', 'tensorflow_compression Documentation',
+     'Johannes Ballé, Sung Jin Hwang, Nick Johnston', '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, 'tensorflow_compression', 'tensorflow_compression 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, 'tensorflow_compression', 'tensorflow_compression Documentation',
+     author, 'tensorflow_compression', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------
+
+autodoc_default_flags = ['inherited-members', 'imported-members']

docs/index.rst

@@ -0,0 +1,82 @@
+.. py:module:: tensorflow_compression
+
+.. toctree::
+   :caption: Table of Contents
+   :collapse: False
+   :maxdepth: 4
+
+
+Keras layers
+============
+
+Entropy models
+--------------
+
+EntropyBottleneck
+^^^^^^^^^^^^^^^^^
+.. autoclass:: EntropyBottleneck
+
+Convolution
+-----------
+
+SignalConv1D
+^^^^^^^^^^^^
+.. autoclass:: SignalConv1D
+
+SignalConv2D
+^^^^^^^^^^^^
+.. autoclass:: SignalConv2D
+
+SignalConv3D
+^^^^^^^^^^^^
+.. autoclass:: SignalConv3D
+
+Activation functions
+--------------------
+
+GDN
+^^^
+.. autoclass:: GDN
+
+Parameterizers
+--------------
+
+These classes specify reparameterizations of variables created in Keras layers.
+
+StaticParameterizer
+^^^^^^^^^^^^^^^^^^^
+.. autoclass:: StaticParameterizer
+
+RDFTParameterizer
+^^^^^^^^^^^^^^^^^
+.. autoclass:: RDFTParameterizer
+
+NonnegativeParameterizer
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. autoclass:: NonnegativeParameterizer
+
+
+TensorFlow operations
+=====================
+
+Range coding
+------------
+
+pmf_to_quantized_cdf
+^^^^^^^^^^^^^^^^^^^^
+.. autofunction:: pmf_to_quantized_cdf
+
+range_encode
+^^^^^^^^^^^^
+.. autofunction:: range_encode
+
+range_decode
+^^^^^^^^^^^^
+.. autofunction:: range_decode
+
+
+Index & search
+==============
+
+* :ref:`genindex`
+* :ref:`search`