From a2566a228d3f520a45626358bcf11ced88475a2b Mon Sep 17 00:00:00 2001 From: João Paulo Nunes Soares Date: Jun 21 2018 01:44:37 +0000 Subject: Updating documentation --- diff --git a/doc/_static/ping_succes.png b/doc/_static/ping_succes.png new file mode 100644 index 0000000..5c599ce Binary files /dev/null and b/doc/_static/ping_succes.png differ diff --git a/doc/development.rst b/doc/development.rst index 5c50444..8e43e42 100644 --- a/doc/development.rst +++ b/doc/development.rst @@ -272,11 +272,11 @@ more info about the Anitya service, read the rest of kiskadee documentation. Tests and coverage -------------------- -To check kiskadee tests and coverage: +To run kiskadee tests and see coverage: .. code-block:: bash - $ make check + $ make test To check kiskadee coverage open the file *covhtml/index.html*. @@ -284,13 +284,32 @@ To run only unit tests: .. code-block:: bash - $ python3 -m unittest kiskadee/tests/units/*.py + $ make test_units To run api tests: .. code-block:: bash - $ python3 -m unittest kiskadee/tests/api/*.py + $ make test_api + +To run integration tests: + +.. code-block:: bash + + $ make test_integration + +To run plugin tests: + +.. code-block:: bash + + $ make test_plugins + +To clean temporary files ( htmlcov,etc..): + +.. code-block:: bash + + $ make clean + building docs -------------------- diff --git a/doc/installing.rst b/doc/installing.rst index 4437f27..3f04a47 100644 --- a/doc/installing.rst +++ b/doc/installing.rst @@ -61,7 +61,13 @@ To check if ansible can access the kiskadee-core virtual machine: ansible -i playbook/hosts.local kiskadee-core -m ping -If you see a success message, we are good to go. +If you see a success message,like the follow one, we are good to go. + +.. figure:: _static/ping_succes.png + :align: center + +.. + To deploy kiskadee locally: