Commit 2efb041e authored by Wout De Nolf's avatar Wout De Nolf

[doc] notebooks in docs

parent 2f3099e3
......@@ -33,6 +33,8 @@
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.mathjax',
'nbsphinx'
]
# Add any paths that contain templates here, relative to this directory.
......@@ -56,9 +58,9 @@ author = 'de nolf'
# built documents.
#
# The short X.Y version.
version = '0.1'
version = '0.0.1'
# The full version, including alpha/beta/rc tags.
release = '0.1'
release = '0.0.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......@@ -70,7 +72,7 @@ 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 = []
exclude_patterns = ['_build','_templates','_autosummary','.ipynb_checkpoints']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
......
......@@ -8,11 +8,17 @@ Welcome to oarpy's documentation!
.. toctree::
:maxdepth: 2
:caption: Contents:
modules.rst
:hidden:
modules
tutorials
:doc:`tutorials`
Some examples on how to use the library
:doc:`modules`
API documentation
Indices and tables
==================
......
Tutorials
=========
.. toctree::
:maxdepth: 3
tutorials/quickstart.rst
tutorials/oarjob.rst
......@@ -4,13 +4,13 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Managing OAR jobs from python\n",
"===========================\n",
"# OAR jobs from python\n",
"\n",
"Three classes are used\n",
"* oarpy.oarjob.Job: manage existing jobs (status, stop, suspend, resume)\n",
"* oarpy.oarjob.JobFactory: define and launch jobs (creates oarpy.oarjob.Job)\n",
"* oarpy.oarresource.Resource: optional OAR resources for JobFactory (nodes, cores, gpu)"
"The library provides three main classes:\n",
"\n",
" * oarpy.oarjob.Job: manage existing jobs (status, stop, suspend, resume)\n",
" * oarpy.oarjob.JobFactory: define and launch jobs (creates oarpy.oarjob.Job)\n",
" * oarpy.oarresource.Resource: optional OAR resources for JobFactory (nodes, cores, gpu)"
]
},
{
......@@ -36,8 +36,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Monitor jobs\n",
"==========="
"## Monitor jobs"
]
},
{
......@@ -193,8 +192,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Define jobs\n",
"=========\n",
"## Define jobs\n",
"The minimal job definition requires only a shell command"
]
},
......@@ -308,8 +306,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Launch jobs\n",
"==========\n",
"## Launch jobs\n",
"Function to define test jobs"
]
},
......@@ -330,8 +327,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Immediate execution\n",
"------------------------------\n",
"### Immediate execution\n",
"Schedule job for execution, wait until done and show output:"
]
},
......@@ -388,8 +384,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"No immediate execution\n",
"-----------------------------------\n",
"### Postpone execution\n",
"\n",
"Enqueue job, wait until enqueued, schedule for execution, wait until done and show output:"
]
......@@ -460,8 +455,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Suspend\n",
"-------------\n",
"### Suspend\n",
"Schedule job for execution, wait until running, suspend/resume, wait until done and show output:"
]
},
......@@ -612,8 +606,8 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Interrupt\n",
"------------\n",
"### Interrupt\n",
"\n",
"Schedule job for execution, waiting until running, interrupt, wait until done and show output:"
]
},
......
......@@ -4,10 +4,12 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Hello world\n",
"=========\n",
"Minimal\n",
"------------"
"# Quick start\n",
"\n",
"## Hello world\n",
"OAR job that prints \"Hello world\" to the standard output.\n",
"\n",
"### Minimal"
]
},
{
......@@ -46,8 +48,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"With resources and postponed execution\n",
"-------------------------------------------------------------"
"### With resources and postponed execution"
]
},
{
......@@ -93,8 +94,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Job management\n",
"==============\n",
"## Job management\n",
"\n",
"Find all jobs started in the last 5 minutes:"
]
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment