Commit 091c9142 authored by payno's avatar payno

[doc] add documentation for the current API

parent db08eaf5
.. oarpy documentation master file, created by
sphinx-quickstart on Mon Nov 19 09:33:29 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to oarpy's documentation!
=================================
.. toctree::
:maxdepth: 2
:caption: Contents:
modules.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
oarpy
=====
.. toctree::
:maxdepth: 4
oarpy
oarpy package
=============
Subpackages
-----------
.. toctree::
oarpy.tests
Submodules
----------
oarpy\.oarjob module
--------------------
.. automodule:: oarpy.oarjob
:members:
:undoc-members:
:show-inheritance:
oarpy\.oarresource module
-------------------------
.. automodule:: oarpy.oarresource
:members:
:undoc-members:
:show-inheritance:
oarpy\.oarshell module
----------------------
.. automodule:: oarpy.oarshell
:members:
:undoc-members:
:show-inheritance:
oarpy\.timeutils module
-----------------------
.. automodule:: oarpy.timeutils
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: oarpy
:members:
:undoc-members:
:show-inheritance:
oarpy\.tests package
====================
Submodules
----------
oarpy\.tests\.test\_all module
------------------------------
.. automodule:: oarpy.tests.test_all
:members:
:undoc-members:
:show-inheritance:
oarpy\.tests\.test\_oarjob module
---------------------------------
.. automodule:: oarpy.tests.test_oarjob
:members:
:undoc-members:
:show-inheritance:
oarpy\.tests\.test\_oarresource module
--------------------------------------
.. automodule:: oarpy.tests.test_oarresource
:members:
:undoc-members:
:show-inheritance:
oarpy\.tests\.test\_oarshell module
-----------------------------------
.. automodule:: oarpy.tests.test_oarshell
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: oarpy.tests
:members:
:undoc-members:
:show-inheritance:
...@@ -16,10 +16,9 @@ ...@@ -16,10 +16,9 @@
"name": "stdout", "name": "stdout",
"output_type": "stream", "output_type": "stream",
"text": [ "text": [
"........\n", ".......\n",
"Succes:\n", "Interrupted:\n",
"Hello word\n", "None\n"
"\n"
] ]
} }
], ],
...@@ -192,14 +191,14 @@ ...@@ -192,14 +191,14 @@
"language_info": { "language_info": {
"codemirror_mode": { "codemirror_mode": {
"name": "ipython", "name": "ipython",
"version": 2 "version": 3
}, },
"file_extension": ".py", "file_extension": ".py",
"mimetype": "text/x-python", "mimetype": "text/x-python",
"name": "python", "name": "python",
"nbconvert_exporter": "python", "nbconvert_exporter": "python",
"pygments_lexer": "ipython2", "pygments_lexer": "ipython3",
"version": "2.7.9" "version": "3.5.2"
} }
}, },
"nbformat": 4, "nbformat": 4,
......
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