Added sphinx docs

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    = dmsky
+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,162 @@
+# -*- 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.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = u'dmsky'
+copyright = u'2018, Alex Drlica-Wagner, Eric Charles, Matthew Wood'
+author = u'Alex Drlica-Wagner, Eric Charles, Matthew Wood'
+
+# The short X.Y version
+version = u''
+# The full version, including alpha/beta/rc tags
+release = u'0.2.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.coverage',
+    'sphinx.ext.viewcode',
+    '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 = [u'_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 = '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']
+
+# 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 = 'dmskydoc'
+
+
+# -- 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, 'dmsky.tex', u'dmsky Documentation',
+     u'Alex Drlica-Wagner, Eric Charles, Matthew Wood', '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, 'dmsky', u'dmsky 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, 'dmsky', u'dmsky Documentation',
+     author, 'dmsky', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------

docs/dmsky.rst

@@ -0,0 +1,86 @@
+.. _dmsky:
+
+dmsky package
+=============
+
+
+dmsky.priors module
+-------------------
+
+.. automodule:: dmsky.priors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+dmsky.factory module
+--------------------
+
+.. automodule:: dmsky.factory
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+dmsky.jcalc module
+------------------
+
+.. automodule:: dmsky.jcalc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+dmsky.density module
+--------------------
+
+.. automodule:: dmsky.density
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+dmsky.library module
+--------------------
+
+.. automodule:: dmsky.library
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+dmsky.plotting module
+---------------------
+
+.. automodule:: dmsky.plotting
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+dmsky.skymap module
+-------------------
+
+.. automodule:: dmsky.skymap
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+dmsky.targets module
+--------------------
+
+.. automodule:: dmsky.targets
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+dmsky.rosters module
+--------------------
+
+.. automodule:: dmsky.roster
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: dmsky
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/dmsky_file_io.rst

@@ -0,0 +1,21 @@
+.. _dmsky_file_io:
+
+dmsky.file_io subpackage
+========================
+
+dmsky.file_io.table module
+--------------------------
+
+.. automodule:: dmsky.file_io.table
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: dmsky.file_io
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/dmsky_utils.rst

@@ -0,0 +1,71 @@
+.. _dmsky_utils:
+
+dmsky.utils subpackage
+======================
+
+dmsky.utils.coords module
+-------------------------
+
+.. automodule:: dmsky.utils.coords
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+dmsky.utils.speed module
+------------------------
+
+.. automodule:: dmsky.utils.speed
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+dmsky.utils.healpix module
+--------------------------
+
+.. automodule:: dmsky.utils.healpix
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+dmsky.utils.stat_funcs module
+-----------------------------
+
+.. automodule:: dmsky.utils.stat_funcs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+dmsky.utils.tools module
+------------------------
+
+.. automodule:: dmsky.utils.tools
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+dmsky.utils.units module
+------------------------
+
+.. automodule:: dmsky.utils.units
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+dmsky.utils.wcs module
+----------------------
+
+.. automodule:: dmsky.utils.wcs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: dmsky.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/index.rst

@@ -0,0 +1,29 @@
+.. dmsky documentation master file, created by
+   sphinx-quickstart on Wed May 16 15:31:55 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to dmsky's documentation!
+=================================
+
+
+Documentation Contents
+----------------------
+
+.. toctree::
+   :includehidden:
+   :maxdepth: 3
+
+   install
+   quickstart
+   dmsky
+   dmsky_utils
+   dmsky_file_io
+
+
+Indices and tables
+==================
+
+.. * :ref:`genindex`
+.. * :ref:`modindex`
+.. * :ref:`search`