Merge pull request #34 from jhamman/feature/docs

Adding basic sphinx docs

README.rst

@@ -1,43 +1,32 @@
 Deploy Dask on Job Queueing systems
 ===================================
 
-This helps to deploy Dask on batch-style job schedulers like PBS and SLURM.
+.. image:: https://travis-ci.org/dask/dask-jobqueue.svg?branch=master
+    :target: https://travis-ci.org/dask/dask-jobqueue
 
-Example
--------
-
-.. code-block:: python
-
-   from dask_jobqueue import PBSCluster
-
-   cluster = PBSCluster(processes=6, threads=4, memory="16GB")
-   cluster.start_workers(10)
-
-   from dask.distributed import Client
-   client = Client(cluster)
+.. image:: https://readthedocs.org/projects/dask-jobqueue/badge/?version=latest
+:target: http://dask-jobqueue.readthedocs.io/en/latest/?badge=latest
+:alt: Documentation Status
 
-Adaptivity
-----------
+|Build Status| |Doc Status| |Gitter| |Version Status|
 
-This can also adapt the cluster size dynamically based on current load.
-This helps to scale up the cluster when necessary but scale it down and save
-resources when not actively computing.
+Easy deployment of Dask Distributed on job queuing systems such as PBS, Slurm,
+or SGE.  See documentation_ for more information.
 
-.. code-block:: python
 
-   cluster.adapt()
-
-
-History
+LICENSE
 -------
 
-This package came out of the `Pangeo <https://pangeo-data.github.io/>`_
-collaboration and was copy-pasted from a live repository at
-`this commit <https://github.com/pangeo-data/pangeo/commit/28f86b9c836bd622daa14d5c9b48ab73bbed4c73>`_.
-Unfortunately, development history was not preserved.
-
-Original developers include the following:
-
--  `Jim Edwards <https://github.com/jedwards4b>`_
--  `Joe Hamman <https://github.com/jhamman>`_
--  `Matthew Rocklin <https://github.com/mrocklin>`_
+New BSD. See `License File <https://github.com/dask/dask-jobqueue/blob/master/LICENSE.txt>`__.
+
+.. _documentation: http://dask-jobqueue.readthedocs.io/en/latest
+.. |Build Status| image:: https://travis-ci.org/dask/dask-jobqueue.svg?branch=master
+   :target: https://travis-ci.org/dask/dask-jobqueue
+.. |Doc Status| image:: https://readthedocs.org/projects/dask-jobqueue/badge/?version=latest
+   :target: http://dask-jobqueue.readthedocs.io/en/latest
+   :alt: Documentation Status
+.. |Gitter| image:: https://badges.gitter.im/Join%20Chat.svg
+   :alt: Join the chat at https://gitter.im/dask/dask
+   :target: https://gitter.im/dask/dask?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+.. |Version Status| image:: https://img.shields.io/pypi/v/dask-jobqueue.svg
+   :target: https://pypi.python.org/pypi/dask-jobqueue/

dask_jobqueue/pbs.py

@@ -43,9 +43,9 @@ class PBSCluster(JobQueueCluster):
     >>> cluster.adapt()
 
     It is a good practice to define local_directory to your PBS system scratch
-    directory,
-    and you should specify resource_spec according to the processes and
-    threads asked:
+    directory, and you should specify resource_spec according to the processes
+    and threads asked:
+
     >>> cluster = PBSCluster(queue='regular', project='DaskOnPBS',
                              local_directory=os.getenv('TMPDIR', '/tmp'),
                              threads=4, processes=6, memory='16GB',

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    = dask-jobqueue
+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/api.rst

@@ -0,0 +1,14 @@
+.. _api:
+
+.. currentmodule:: dask_jobqueue
+
+
+API
+===
+
+.. autosummary::
+   :toctree: generated/
+
+   PBSCluster
+   SLURMCluster
+   SGECluster

docs/conf.py

@@ -0,0 +1,189 @@
+# -*- 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/stable/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 -----------------------------------------------------
+
+author = u'Dask-jobqueue Development Team'
+project = u'Dask-jobqueue'
+copyright = u'2018, Anaconda, Inc. and contributors'
+
+
+# The short X.Y version.
+# version = '0.1.0'
+from dask_jobqueue import __version__ as version
+# The full version, including alpha/beta/rc tags.
+# release = '0.1.0'
+release = version
+
+
+# -- 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.intersphinx',
+    'sphinx.ext.mathjax',
+]
+extensions = ['sphinx.ext.autodoc',
+              'sphinx.ext.mathjax',
+              'sphinx.ext.intersphinx',
+              'sphinx.ext.autosummary',
+              'sphinx.ext.extlinks',
+              'numpydoc']
+
+autosummary_generate = True
+
+numpydoc_class_members_toctree = True
+numpydoc_show_class_members = True
+
+# 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 = {}
+
+# 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 = 'dask-jobqueudoc'
+
+
+# -- 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, 'dask-jobqueue.tex', 'Dask-jobqueue Documentation',
+     [author], '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, 'dask-jobqueue', 'Dask-jobqueue 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, 'dask-jobqueue', 'Dask-jobqueue Documentation',
+     author, 'dask-jobqueue', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+    'pandas': ('http://pandas.pydata.org/pandas-docs/stable/',
+               'http://pandas.pydata.org/pandas-docs/stable/objects.inv'),
+    'numpy': ('https://docs.scipy.org/doc/numpy/',
+              'https://docs.scipy.org/doc/numpy/objects.inv'),
+    'dask': ('http://dask.pydata.org/en/latest',
+             'http://dask.pydata.org/en/latest/objects.inv'),
+    'distributed': ('https://distributed.readthedocs.io/en/stable/',
+                    'https://distributed.readthedocs.io/en/stable/objects.inv')
+}

docs/examples.rst

@@ -0,0 +1,19 @@
+Example Deployments
+===================
+
+Deploying dask-jobqueue on different clusters requires a bit of customization.
+Below, we provide a few example deployments:
+
+
+Example PBS Deployment
+----------------------
+
+.. code-block:: python
+
+   from dask_jobqueue import PBSCluster
+
+   cluster = PBSCluster(processes=6, threads=4, memory="16GB")
+   cluster.start_workers(10)
+
+   from dask.distributed import Client
+   client = Client(cluster)