Add contribute, site and plugin documentation

MatterMiners · May 29, 2019 · 1507fa8 · 1507fa8
1 parent 5e9b049
commit 1507fa8
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 7 deletions.
diff --git a/docs/source/adapters/site.rst b/docs/source/adapters/site.rst
@@ -0,0 +1,27 @@
+============
+Site Adapter
+============
+
+Cloud Stack Site Adapter
+------------------------
+:py:class:`~tardis.adapters.sites.cloudstack.CloudStackAdapter`
+
+HTCondor Site Adapter
+---------------------
+:py:class:`~tardis.adapters.sites.htcondor.HTCondorAdapter`
+
+Moab Site Adapter
+-----------------
+:py:class:`~tardis.adapters.sites.moab.MoabAdapter`
+
+OpenStack Site Adapter
+----------------------
+:py:class:`~tardis.adapters.sites.openstack.OpenStackAdapter`
+
+Slurm Site Adapter
+------------------
+:py:class:`~tardis.adapters.sites.slurm.SlurmAdapter`
+
+Your favorite site is currently not supported?
+Please, have a look at
+:ref:`how to contribute.<ref_contribute_site_adapter>`
diff --git a/docs/source/contribute/contribute.rst b/docs/source/contribute/contribute.rst
@@ -8,6 +8,16 @@ Batch System Adapter
 --------------------
 :py:class:`~tardis.interfaces.batchsystemadapter.BatchSystemAdapter`
 
+.. _ref_contribute_site_adapter:
+
 Site Adapter
 ------------
 :py:class:`~tardis.interfaces.siteadapter.SiteAdapter`
+
+.. _ref_contribute_plugin:
+
+Plugin
+-------
+:py:class:`~tardis.interfaces.plugin.Plugin`
+
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,19 +1,27 @@
-.. tardis documentation master file, created by
-   sphinx-quickstart on Fri Jun  8 14:53:15 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+======================================================================
+TARDIS - The Transparent Adaptive Resource Dynamic Integration System
+======================================================================
 
-Welcome to tardis's documentation!
-==================================
+Welcome to the TARDIS documentation!
+====================================
 
 .. toctree::
+   :hidden:
    :maxdepth: 2
    :caption: Contents:
 
-   api/modules
    adapters/batchsystem
+   adapters/site
+   plugins/plugins
    contribute/contribute
+   Module Index <api/modules>
 
+.. image:: ../pics/TARDIS_logo.svg
+    :alt: TARDIS Logo
+    :height: 150
+    :align: left
+
+The ``TARDIS`` package
 
 Indices and tables
 ==================

diff --git a/docs/source/plugins/plugins.rst b/docs/source/plugins/plugins.rst
@@ -0,0 +1,15 @@
+=======
+Plugins
+=======
+
+Sqlite Registry
+---------------
+:py:class:`~tardis.plugins.sqliteregistry.SqliteRegistry`
+
+Telegraf Monitoring
+-------------------
+:py:class:`~tardis.plugins.telegrafmonitoring.TelegrafMonitoring`
+
+Your favorite monitoring is currently not supported?
+Please, have a look at
+:ref:`how to contribute.<ref_contribute_plugin>`