Fix OPNFV wiki APEX dead link

[docs.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index bb48fddb14de9257fe1e80ccb824d09939fb8cee..87c3cbdd4718ee2888c69cb3766449a4e33964fa 100755 (executable)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -11,31 +11,31 @@
 ##############################################################################
 
 from docs_conf.conf import *
+import sys, os, csv
 
-# Append to intersphinx_mapping
-intersphinx_mapping['aaa'] = ('https://docs.opendaylight.org/projects/aaa/en/latest/', None)
-intersphinx_mapping['controller'] = ('https://docs.opendaylight.org/projects/controller/en/latest/', None)
-intersphinx_mapping['infrautils'] = ('https://docs.opendaylight.org/projects/infrautils/en/latest/', None)
-intersphinx_mapping['mdsal'] = ('https://docs.opendaylight.org/projects/mdsal/en/latest/', None)
-intersphinx_mapping['netconf'] = ('https://docs.opendaylight.org/projects/netconf/en/latest/', None)
-intersphinx_mapping['odl-integration-test'] = ('https://docs.opendaylight.org/projects/integration-test/en/latest/', None)
-intersphinx_mapping['odl-integration-packaging'] = ('https://docs.opendaylight.org/projects/integration-packaging/en/latest/', None)
-intersphinx_mapping['odl-releng-builder'] = ('https://docs.opendaylight.org/projects/releng-builder/en/latest/', None)
-intersphinx_mapping['opflex'] = ('https://docs.opendaylight.org/projects/opflex/en/latest/', None)
 
-# Projects that have stable/branches
-intersphinx_mapping['bgpcep'] = ('https://docs.opendaylight.org/projects/bgpcep/en/latest/', None)
-intersphinx_mapping['daexim'] = ('https://docs.opendaylight.org/projects/daexim/en/latest/', None)
-intersphinx_mapping['genius'] = ('https://docs.opendaylight.org/projects/genius/en/latest/', None)
-intersphinx_mapping['integration-distribution'] = ('https://docs.opendaylight.org/projects/integration-distribution/en/latest/', None)
-intersphinx_mapping['jsonrpc'] = ('https://docs.opendaylight.org/projects/jsonrpc/en/latest/', None)
-intersphinx_mapping['lispflowmapping'] = ('https://docs.opendaylight.org/projects/lispflowmapping/en/latest/', None)
-intersphinx_mapping['openflowplugin'] = ('https://docs.opendaylight.org/projects/openflowplugin/en/latest/', None)
-intersphinx_mapping['ovsdb'] = ('https://docs.opendaylight.org/projects/ovsdb/en/latest/', None)
-intersphinx_mapping['transportpce'] = ('https://docs.opendaylight.org/projects/transportpce/en/latest/', None)
+def update_intersphinx_mapping():
+    with open('../projects_list.tsv') as fd:
+        rd = csv.reader(fd, delimiter="\t", quotechar='"')
+        for row in rd:
+            if row:
+                project = row[0]
+                if project[0] == "#":
+                    continue
+                version = row[1]
+                intersphinx_mapping[project] = (f'https://docs.opendaylight.org/projects/{project}/en/{version}/', None)
+
+
+# Append to intersphinx_mapping
+update_intersphinx_mapping()
 
 # OpenDaylight Documentation Releases
-intersphinx_mapping['odl-phosphorus'] = ('https://docs.opendaylight.org/en/latest/', None)
+intersphinx_mapping['odl-calcium'] = ('https://docs.opendaylight.org/en/latest/', None)
+intersphinx_mapping['odl-potassium'] = ('https://docs.opendaylight.org/en/stable-potassium/', None)
+intersphinx_mapping['odl-argon'] = ('https://docs.opendaylight.org/en/stable-argon/', None)
+intersphinx_mapping['odl-chlorine'] = ('https://docs.opendaylight.org/en/stable-chlorine/', None)
+intersphinx_mapping['odl-sulfur'] = ('https://docs.opendaylight.org/en/stable-sulfur/', None)
+intersphinx_mapping['odl-phosphorus'] = ('https://docs.opendaylight.org/en/stable-phosphorus/', None)
 intersphinx_mapping['odl-silicon'] = ('https://docs.opendaylight.org/en/stable-silicon/', None)
 intersphinx_mapping['odl-aluminium'] = ('https://docs.opendaylight.org/en/stable-aluminium/', None)
 intersphinx_mapping['odl-magnesium'] = ('https://docs.opendaylight.org/en/stable-magnesium/', None)
@@ -74,6 +74,9 @@ linkcheck_ignore = [
     'http://checkstyle.sourceforge.net/config_coding.html#.*',
     # this url often has connectivity issues on the gate
     'https://www.mojohaus.org/animal-sniffer/animal-sniffer-maven-plugin/examples/checking-signatures.html',
+    #Ignore announce page link till it is up
+    'https://www.opendaylight.org/current-release-potassium',
+    'https://www.opendaylight.org/current-release-argon',
 ]
 linkcheck_timeout = 300
 
@@ -81,11 +84,19 @@ nitpicky = True
 release = version
 
 spelling_warning = True
-spelling_exclude_patterns = ['release-notes/release-notes-*']
+spelling_exclude_patterns = ['release-notes/release-notes-*', 'release-notes/projects/*']
 
 html_context = {
     'version_status': 'supported',
 }
 
+# Helper for JIRA references
+sys.path.append(os.path.abspath('ext'))
+extensions.append('odl-jira')
+
+# Set language to English
+language = "en"
+
+
 def setup(app):
     app.add_css_file("css/ribbon.css")