From 3111b5eb14d72bbfee7fc2c13a889fc2f6e04bc9 Mon Sep 17 00:00:00 2001 From: Jeremy Cline Date: Jun 05 2017 16:54:07 +0000 Subject: Add an intro and the API to the docs Signed-off-by: Jeremy Cline --- diff --git a/docs/api.rst b/docs/api.rst index 4e2488b..1ab5f32 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -9,3 +9,8 @@ Greenwave APIs HTTP REST API ============= + +.. autoflask:: greenwave.app_factory:create_app('greenwave.config.DevelopmentConfig') + :undoc-static: + :modules: greenwave.api_v1 + :order: path diff --git a/docs/index.rst b/docs/index.rst index 7ae75b5..8cacf95 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,15 +3,20 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +========= Greenwave ========= +`Greenwave`_ is a service to decide whether a software artifact can pass certain +gating points in a software delivery pipeline, based on test results stored in +`ResultsDB`_ and waivers stored in `WaiverDB`_. + .. toctree:: :maxdepth: 2 :caption: Contents: - contributing api + contributing Indices and tables @@ -20,3 +25,8 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` + + +.. _Greenwave: https://pagure.io/greenwave +.. _ResultsDB: https://pagure.io/taskotron/resultsdb +.. _WaiverDB: https://pagure.io/waiverdb