Started writing Sphinx documentation

NERSC · May 11, 2019 · 83f97bd · 83f97bd
1 parent 551ab57
commit 83f97bd
Show file tree

Hide file tree

Showing 61 changed files with 16,051 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 A JupyterLab extension that interfaces with the Slurm Workload Manager, 
 providing simple and intuitive controls for viewing and managing jobs on the queue.
 
-![Slurm Extension](./slurm.png)
+![Slurm Extension](./docs/images/slurm.png)
 
 ## Prerequisites
 

diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+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)
diff --git a/docs/_build/doctrees/contents/configuration.doctree b/docs/_build/doctrees/contents/configuration.doctree
diff --git a/docs/_build/doctrees/contents/development.doctree b/docs/_build/doctrees/contents/development.doctree
diff --git a/docs/_build/doctrees/contents/installation.doctree b/docs/_build/doctrees/contents/installation.doctree
diff --git a/docs/_build/doctrees/contents/overview.doctree b/docs/_build/doctrees/contents/overview.doctree
diff --git a/docs/_build/doctrees/contents/usage.doctree b/docs/_build/doctrees/contents/usage.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: a5997e5d4544ee8c5ab75e41174603bb
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/.nojekyll b/docs/_build/html/.nojekyll
diff --git a/slurm.png → docs/_build/html/_images/slurm.png b/slurm.png → docs/_build/html/_images/slurm.png
diff --git a/docs/_build/html/_sources/contents/configuration.rst.txt b/docs/_build/html/_sources/contents/configuration.rst.txt
@@ -0,0 +1,4 @@
+.. _configuration:
+
+Configuration
+-------------
diff --git a/docs/_build/html/_sources/contents/development.rst.txt b/docs/_build/html/_sources/contents/development.rst.txt
@@ -0,0 +1,4 @@
+.. _development:
+
+Development
+------------
diff --git a/docs/_build/html/_sources/contents/installation.rst.txt b/docs/_build/html/_sources/contents/installation.rst.txt
@@ -0,0 +1,37 @@
+.. _installation:
+
+Installation
+------------
+
+The jupyterlab-slurm extension requires both a client-side `JupyterLab extension <https://www.npmjs.com/package/jupyterlab-slurm>`__ and a server-side
+Jupyter `notebook server extension <https://pypi.org/project/jupyterlab-slurm/>`__.
+
+Prerequisites
+~~~~~~~~~~~~~
+Make sure you have the following prerequisites installed on your system before getting started.
+
+* JupyterLab >= 0.35
+* Node.js 5+
+* Slurm 
+
+Install the notebook server extension from PyPi using ``pip``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. code:: bash
+
+    pip install jupyterlab_slurm
+
+If you are running Notebook 5.2 or earlier, enable the server extension by running
+
+.. code:: bash
+
+    jupyter serverextension enable --py --sys-prefix jupyterlab_slurm
+
+Install the JupyterLab extension from NPM
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. code:: bash
+
+    jupyter labextension install jupyterlab-slurm
+
+Now you should be all set. After launching JupyterLab, the extension can be found in the command palette under
+the name ``Slurm Queue Manager``, and is listed under the ``HPC TOOLS`` section
+of the palette and the launcher.
diff --git a/docs/_build/html/_sources/contents/overview.rst.txt b/docs/_build/html/_sources/contents/overview.rst.txt
@@ -0,0 +1,4 @@
+.. _overview:
+
+Overview
+--------
diff --git a/docs/_build/html/_sources/contents/usage.rst.txt b/docs/_build/html/_sources/contents/usage.rst.txt
@@ -0,0 +1,4 @@
+.. _usage:
+
+Usage
+-----
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -0,0 +1,32 @@
+.. jupyterlab-slurm documentation master file, created by
+   sphinx-quickstart on Sun Feb 17 22:59:14 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to jupyterlab-slurm's documentation
+============================================
+
+A JupyterLab extension that interfaces with the Slurm Workload Manager, 
+providing simple and intuitive controls for viewing and managing jobs on the queue.
+
+.. image:: ./images/slurm.png
+   :align: center
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   contents/overview
+   contents/installation
+   contents/usage
+   contents/configuration
+   contents/development
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/_build/html/_static/ajax-loader.gif b/docs/_build/html/_static/ajax-loader.gif