Add Getting Started Documentation (#141)

Author: manoelmarques

README.md

@@ -39,7 +39,14 @@ To do this follow the instructions in the
 
 ### Optional Installs
 
-* **IBM CPLEX** may be installed using `pip install 'qiskit-optimization[cplex]'` to enable the reading of `LP` files.
+* **IBM CPLEX** may be installed using `pip install 'qiskit-optimization[cplex]'` to enable the reading of `LP` files and the usage of
+  the `CplexOptimizer`, wrapper for ``cplex.Cplex``.
+
+* **CVXPY** may be installed using command `pip install 'qiskit-optimization[cvx]'` to install the
+  package. CVXPY being installed will enable the usage of the Goemans-Williamson algorithm as an optimizer `GoemansWilliamsonOptimizer`.
+
+* **Matplotlib** may be installed using command `pip install 'qiskit-optimization[matplotlib]'` to install the
+  package. Matplotlib being installed will enable the usage of the `draw` method in the graph optimization application classes.
 
 ### Creating Your First Optimization Programming Experiment in Qiskit
 

docs/conf.py

@@ -26,13 +26,18 @@
 import os
 import sys
 sys.path.insert(0, os.path.abspath('..'))
+sys.path.append(os.path.abspath('.'))
 
 """
 Sphinx documentation builder
 """
 
 import qiskit_sphinx_theme
 import qiskit_optimization
+from custom_directives import (IncludeDirective, GalleryItemDirective,
+                               CustomGalleryItemDirective, CustomCalloutItemDirective,
+                               CustomCardItemDirective)
+
 # Set env flag so that we can doc functions that may otherwise not be loaded
 # see for example interactive visualizations in qiskit.visualization.
 os.environ['QISKIT_DOCS'] = 'TRUE'
@@ -86,7 +91,7 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
     'sphinx.ext.extlinks',
-    'sphinx_tabs.tabs',
+    'sphinx_panels',
     'jupyter_sphinx',
     'sphinx_autodoc_typehints',
     'reno.sphinxext',
@@ -197,3 +202,14 @@
     'includehidden': True,
     'titles_only': False,
 }
+
+# -- Extension configuration -------------------------------------------------
+
+
+def setup(app):
+    app.add_directive('includenodoc', IncludeDirective)
+    app.add_directive('galleryitem', GalleryItemDirective)
+    app.add_directive('customgalleryitem', CustomGalleryItemDirective)
+    app.add_directive('customcarditem', CustomCardItemDirective)
+    app.add_directive('customcalloutitem', CustomCalloutItemDirective)
+