PR#112: Updating documentation - kiskadee

João Paulo Nunes Soares • 5 years ago

a2566a2

doc/_static/ping_succes.png

file added

empty or binary file added

doc/development.rst

file modified

+23 -4

		`@@ -272,11 +272,11 @@`
		`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 @@`

		`.. 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`
		`--------------------`

doc/installing.rst

file modified

+7 -1

		`@@ -61,7 +61,13 @@`

		`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:`