Merge documentation from edoddridge

Author: jahn

doc/Makefile

@@ -1,28 +1,20 @@
+# Minimal makefile for Sphinx documentation
 #
-ALL = \
-  devel_HOWTO.ps \
-  devel_HOWTO.pdf \
-  devel_HOWTO_multipage \
-  devel_HOWTO_onepage
 
-all: $(ALL)
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = MITgcm
+SOURCEDIR     = .
+BUILDDIR      = _build
 
-install: all
-	./install_devel_HOWTO
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-devel_HOWTO.ps:  devel_HOWTO.sgml
-	docbook2ps -d ldp.dsl devel_HOWTO.sgml
+.PHONY: help Makefile
 
-devel_HOWTO.pdf:  devel_HOWTO.sgml
-	docbook2pdf -d ldp.dsl devel_HOWTO.sgml
-
-devel_HOWTO_multipage:  devel_HOWTO.sgml
-	docbook2html -o devel_HOWTO_multipage -d ./ldp.dsl devel_HOWTO.sgml
-	( cd devel_HOWTO_multipage && cp -p t1.htm index.html )
-
-devel_HOWTO_onepage:  devel_HOWTO.sgml
-	docbook2html -u -o devel_HOWTO_onepage -d ./ldp.dsl devel_HOWTO.sgml
-	( cd devel_HOWTO_onepage && mv devel_HOWTO.html index.html )
-
-clean:
-	rm -rf $(ALL)
+# 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/conf.py

@@ -0,0 +1,181 @@
+# -*- coding: utf-8 -*-
+#
+# MITgcm documentation build configuration file, created by
+# sphinx-quickstart on Tue Jun  6 11:04:04 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.mathjax',
+    'sphinx.ext.viewcode',
+    'sphinxcontrib.bibtex']
+
+# 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 = u'MITgcm'
+copyright = u'2017, Alistair Adcroft, Jean-Michel Campin, Stephanie Dutkiewicz, Constantinos Evangelinos, David Ferreira, Mick Follows, Gael Forget, Baylor Fox-Kemper, Patrick Heimbach, Chris Hill, Ed Hill, Helen Hill, Oliver Jahn, Martin Losch, John Marshall, Guillaume Maze, Dimitris Menemenlis and Andrea Molod'
+author = u'Alistair Adcroft, Jean-Michel Campin, Stephanie Dutkiewicz, Constantinos Evangelinos, David Ferreira, Mick Follows, Gael Forget, Baylor Fox-Kemper, Patrick Heimbach, Chris Hill, Ed Hill, Helen Hill, Oliver Jahn, Martin Losch, John Marshall, Guillaume Maze, Dimitris Menemenlis and Andrea Molod'
+
+# 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 = u'1.0'
+# The full version, including alpha/beta/rc tags.
+release = u'1.0'
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store']
+
+# 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
+
+
+# number figures
+
+numfig_format = {'figure': 'Figure %s',
+                 'table': 'Table %s',
+                 'code-block': 'Code %s',
+                }
+
+numfig = True
+
+# number figures within section
+numfig_secnum_depth = 1
+
+math_number_all = True
+
+numfig_format = {'figure': 'Figure %s', 'table': 'Table %s', 'code-block': 'Listing %s', 'section': 'Section %s'}
+
+# -- 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'
+
+import sphinx_rtd_theme
+
+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']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'MITgcmdoc'
+
+
+# -- 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, 'MITgcm.tex', u'MITgcm Documentation',
+     u'Alistair Adcroft, Jean-Michel Campin, Stephanie Dutkiewicz, \\and Constantinos Evangelinos, David Ferreira, Mick Follows, \\and Gael Forget, Baylor Fox-Kemper, Patrick Heimbach, Chris Hill, \\and Ed Hill, Helen Hill, Oliver Jahn, Martin Losch, John Marshall, \\and Guillaume Maze, Dimitris Menemenlis and Andrea Molod', '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, 'mitgcm', u'MITgcm 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, 'MITgcm', u'MITgcm Documentation',
+     author, 'MITgcm', 'A highly configurable general circulation model.',
+     'Miscellaneous'),
+]
+
+
+