Remove linkcheck and add API examples

[doc.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index 580cce8..ff9deae 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -24,7 +24,7 @@ import shlex
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+needs_sphinx = '1.5.3'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -34,10 +34,20 @@ extensions = [
     'sphinx.ext.doctest',
     'sphinx.ext.graphviz',
     'sphinx.ext.todo',
-    'sphinx.ext.pngmath',
+    'sphinx.ext.imgmath',
     'sphinx.ext.viewcode',
+    'sphinxcontrib.blockdiag',
+    'sphinxcontrib.seqdiag',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.todo',
+    'sphinxcontrib.httpdomain',
+    'sphinxcontrib.plantuml',
+    'sphinxcontrib.swaggerdoc'
 ]
 
+# Font path for seqdiag
+seqdiag_fontpath= '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -62,9 +72,9 @@ author = u'ONAP Contributors'
 # built documents.
 #
 # The short X.Y version.
-version = 'test'
+version = 'pre-release alpha'
 # The full version, including alpha/beta/rc tags.
-release = 'test'
+release = 'Amsterdam 0.1 alpha'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -81,7 +91,9 @@ language = None
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = [
+       '_build'
+       ]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -359,3 +371,7 @@ epub_exclude_files = ['search.html']
 
 # If false, no index is generated.
 #epub_use_index = True
+
+# Patterns to ignore in linkcheck builder
+linkcheck_ignore = [r'http://localhost:\d+/']
+