Updated doc

.gitignore

@@ -3,3 +3,4 @@ __pycache__
 *.swp
 *.pyc
 examples/output
+doc/build

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = xnmt
+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)

doc/source/conf.py

@@ -0,0 +1,160 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# xnmt documentation build configuration file, created by
+# sphinx-quickstart on Mon May 29 09:58:33 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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('.'))
+
+
+# -- 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.imgmath',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages']
+
+# 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'
+
+# General information about the project.
+project = 'xnmt'
+copyright = '2017, xnmt team'
+author = 'xnmt team'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
+
+# 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 patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = 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 = 'alabaster'
+
+# 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']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'xnmtdoc'
+
+
+# -- 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, 'xnmt.tex', 'xnmt Documentation',
+     'xnmt team', '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, 'xnmt', 'xnmt 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, 'xnmt', 'xnmt Documentation',
+     author, 'xnmt', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

doc/index.rst → doc/source/index.rst

@@ -1,10 +1,13 @@
 .. xnmt documentation master file, created by
+   sphinx-quickstart on Mon May 29 09:58:33 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
 
-eXtensible Neural Machine Translation (xnmt)
-============================================
+eXtensible Neural Machine Translation
+=====================================
 
 This is a repository for the extensible neural machine translation toolkit ``xnmt``.
-It is coded in Python based on `DyNet <http://github.com/clab/dynet>`.
+It is coded in Python based on `DyNet <http://github.com/clab/dynet>`_.
 
 Usage Directions
 ----------------
@@ -17,11 +20,11 @@ which trains an attentional encoder-decoder model, you can do so by running
 
 There are other examples here:
 
-* ``examples/standard.yaml``: An attentional encoder-decoder model
-* ``examples/debug.yaml``: A simple debugging configuration that should run super-fast
-* ``examples/speech.yaml``: An example of speech-to-text translation
+- ``examples/standard.yaml``: A standard neural MT model
+- ``examples/debug.yaml``: A simple debugging configuration that should run super-fast
+- ``examples/speech.yaml``: An example of speech-to-text translation
 
-See ``experiments.md`` for more details about writing experiment configuration files.
+See [experiments.md](experiments.md) for more details about writing experiment configuration files.
 
 Programming Style
 -----------------
@@ -32,14 +35,28 @@ single file, over-riding an existing class). Obviously this ideal will not be re
 time, but when designing new functionality, try to think of this goal.
 
 There are also a minimal of coding style conventions:
-* Follow Python conventions, and be Python2/3 compatible.
-* Functions should be snake case.
-* Indentation should be two whitespace characters.
+- Follow Python conventions, and be Python2/3 compatible.
+- Functions should be snake case.
+- Indentation should be two whitespace characters.
 
 We will aim to write unit tests to make sure things don't break, but these are not implemented yet.
 
 In variable names, common words should be abbreviated as:
-* source -> src
-* target -> trg
-* sentence -> sent
-* hypothesis -> hyp
+- source -> src
+- target -> trg
+- sentence -> sent
+- hypothesis -> hyp
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`