docs: Updating documentation for 0.1.0 release
Change-Id: I1834a8a2ba9a9c7059517e3dbd784a377b0457bd
Refs: #1583
diff --git a/docs/conf.py b/docs/conf.py
index 132c961..8131fcb 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -33,6 +33,23 @@
'sphinx.ext.todo',
]
+def addExtensionIfExists(extension):
+ try:
+ __import__(extension)
+ extensions.append(extension)
+ except ImportError, e:
+ print e
+ sys.stderr.write("Extension '%s' in not available. "
+ "Some documentation may not build correctly.\n" % extension)
+ sys.stderr.write("To install, use \n"
+ " sudo pip install %s\n" % extension.replace('.', '-'))
+ pass
+
+addExtensionIfExists('sphinxcontrib.doxylink')
+
+if os.getenv('GOOGLE_ANALYTICS', None):
+ addExtensionIfExists('sphinxcontrib.googleanalytics')
+
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -243,3 +260,16 @@
# If true, show URL addresses after external links.
man_show_urls = True
+
+
+# ---- Custom options --------
+
+doxylink = {
+ 'ndn-cxx' : ('ndn-cxx.tag', 'doxygen/'),
+}
+
+if os.getenv('GOOGLE_ANALYTICS', None):
+ googleanalytics_id = os.environ['GOOGLE_ANALYTICS']
+ googleanalytics_enabled = True
+
+exclude_patterns = ['RELEASE_NOTES.rst']