documentattion improved

BBVA · Nov 4, 2017 · 90cff1c · 90cff1c
1 parent 6576135
commit 90cff1c
Show file tree

Hide file tree

Showing 20 changed files with 552 additions and 142 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/deeptracy/__init__.py b/deeptracy/__init__.py
@@ -11,7 +11,11 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+"""
+Deeptracy Workers Package.
 
+This package contains celery workers and tasks to process the deeptracy flow for scanning projects.
+"""
 import logging
 
 from .config import LOG_LEVEL

diff --git a/deeptracy/celery.py b/deeptracy/celery.py
@@ -1,19 +1,13 @@
-# Copyright 2017 BBVA
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """
-Module for deeptracy
+Celery worker module.
+~~~~~~~~~~~~~~~~~~~~~
+
+This module can be launched with celery to create workers to handle tasks.
+
+Run deeptracy celery workers with `INFO` log levels::
+
+    $ celery -A deeptracy.celery:celery worker -l INFO
+
 """
 from celery import Celery
 

diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,27 @@
+.. _api:
+
+API Reference
+-------------
+
+This section of the documentation exposes the API methods availables
+to interact with.
+
+.. _create_project-ref:
+
+Create Projects
+~~~~~~~~~~~~~~~
+
+.. _create_scan-ref:
+
+Create Scan
+~~~~~~~~~~~
+
+.. _get_analyzer_vulnerabilties-ref:
+
+Get Analyzer Vulnerabilities
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. _get_scan_vulnerabilities-ref:
+
+Get Scan Vulnerabilities
+~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/deeptracy.dal.rst b/docs/deeptracy.dal.rst
diff --git a/docs/deeptracy.notifications.rst b/docs/deeptracy.notifications.rst
@@ -0,0 +1,22 @@
+deeptracy\.notifications package
+================================
+
+Submodules
+----------
+
+deeptracy\.notifications\.slack\_webhook\_post module
+-----------------------------------------------------
+
+.. automodule:: deeptracy.notifications.slack_webhook_post
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: deeptracy.notifications
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/deeptracy.plugins.rst b/docs/deeptracy.plugins.rst
diff --git a/docs/deeptracy.rst b/docs/deeptracy.rst
@@ -6,17 +6,16 @@ Subpackages
 
 .. toctree::
 
-    deeptracy.dal
-    deeptracy.plugins
+    deeptracy.notifications
     deeptracy.tasks
 
 Submodules
 ----------
 
-deeptracy\.app module
----------------------
+deeptracy\.celery module
+------------------------
 
-.. automodule:: deeptracy.app
+.. automodule:: deeptracy.celery
     :members:
     :undoc-members:
     :show-inheritance:
@@ -29,18 +28,10 @@ deeptracy\.config module
     :undoc-members:
     :show-inheritance:
 
-deeptracy\.redis module
------------------------
-
-.. automodule:: deeptracy.redis
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-deeptracy\.utils module
------------------------
+deeptracy\.plugin\_store module
+-------------------------------
 
-.. automodule:: deeptracy.utils
+.. automodule:: deeptracy.plugin_store
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/docs/deeptracy.tasks.rst b/docs/deeptracy.tasks.rst
@@ -4,6 +4,14 @@ deeptracy\.tasks package
 Submodules
 ----------
 
+deeptracy\.tasks\.base\_task module
+-----------------------------------
+
+.. automodule:: deeptracy.tasks.base_task
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 deeptracy\.tasks\.merge\_results module
 ---------------------------------------
 
@@ -12,6 +20,22 @@ deeptracy\.tasks\.merge\_results module
     :undoc-members:
     :show-inheritance:
 
+deeptracy\.tasks\.notify\_results module
+----------------------------------------
+
+.. automodule:: deeptracy.tasks.notify_results
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+deeptracy\.tasks\.prepare\_scan module
+--------------------------------------
+
+.. automodule:: deeptracy.tasks.prepare_scan
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 deeptracy\.tasks\.run\_analyzer module
 --------------------------------------
 
@@ -20,6 +44,14 @@ deeptracy\.tasks\.run\_analyzer module
     :undoc-members:
     :show-inheritance:
 
+deeptracy\.tasks\.scan\_deps module
+-----------------------------------
+
+.. automodule:: deeptracy.tasks.scan_deps
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 deeptracy\.tasks\.start\_scan module
 ------------------------------------
 

diff --git a/docs/developer.rst b/docs/developer.rst
@@ -0,0 +1,13 @@
+.. _developer-ref:
+
+Developer's Documentation
+=========================
+
+This documentation is for developers who want to contribute to Deeptracy.
+
+.. toctree::
+    :maxdepth: 3
+
+    installation_dev
+    usage_dev
+    testing_dev
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,20 +1,17 @@
-.. deeptracy worker documentation master file.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+:orphan:
 
+Welcome to Deeptracy
+====================
 
-Overview
-========
+.. image::  https://raw.githubusercontent.com/BBVA/deeptracy/develop/docs/_static/deeptracy-logo-small.png
+   :alt: Deeptracy: spot vulnerabilities in your dependencies
+   :width: 250 px
 
-.. toctree::
-   :maxdepth: 2
+Welcome to Deeptracy's documentation. This documentation is divided into two different parts.
+One is the :ref:`userdocs-ref` which include installation and usage, and the other is the
+:ref:`developer-ref` which include :ref:`sourcecode-ref` documentation, local environment, testing
+and so on.
 
-   overview/index
-
-Source Code
-===========
-
-.. toctree::
-   :maxdepth: 3
-
-   modules
+.. include:: user.rst
+.. include:: developer.rst
+.. include:: modules.rst