X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=5aeb1860e7431ab84f2390563e4b878b5d77aed2;hb=c00eeee8bac9b6fde2dc0a14b45fad2dc6858883;hp=648931afc3ebeda08e7c0fffb16816e01efb5520;hpb=b95ace792bddb94f0751471a1c473278090f4f4a;p=docs.git diff --git a/docs/conf.py b/docs/conf.py index 648931afc..5aeb1860e 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,48 +13,75 @@ from docs_conf.conf import * # 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-distribution'] = ('https://docs.opendaylight.org/projects/integration-distribution/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['aaa'] = ('https://docs.opendaylight.org/projects/aaa/en/latest/', None) intersphinx_mapping['bgpcep'] = ('https://docs.opendaylight.org/projects/bgpcep/en/latest/', None) -intersphinx_mapping['coe'] = ('https://docs.opendaylight.org/projects/coe/en/latest/', None) -intersphinx_mapping['controller'] = ('https://docs.opendaylight.org/projects/controller/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['infrautils'] = ('https://docs.opendaylight.org/projects/infrautils/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['netconf'] = ('https://docs.opendaylight.org/projects/netconf/en/latest/', None) -intersphinx_mapping['netvirt'] = ('https://docs.opendaylight.org/projects/netvirt/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['sxp'] = ('https://docs.opendaylight.org/projects/sxp/en/latest/', None) -intersphinx_mapping['tsdr'] = ('https://docs.opendaylight.org/projects/tsdr/en/latest/', None) -intersphinx_mapping['unimgr'] = ('https://docs.opendaylight.org/projects/unimgr/en/latest/', None) +intersphinx_mapping['transportpce'] = ('https://docs.opendaylight.org/projects/transportpce/en/latest/', None) # OpenDaylight Documentation Releases +intersphinx_mapping['odl-phosphorus'] = ('https://docs.opendaylight.org/en/latest/', 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) +intersphinx_mapping['odl-sodium'] = ('https://docs.opendaylight.org/en/stable-sodium/', None) +intersphinx_mapping['odl-neon'] = ('https://docs.opendaylight.org/en/stable-neon/', None) +intersphinx_mapping['odl-fluorine'] = ('https://docs.opendaylight.org/en/stable-fluorine/', None) intersphinx_mapping['odl-oxygen'] = ('https://docs.opendaylight.org/en/stable-oxygen/', None) intersphinx_mapping['odl-nitrogen'] = ('https://docs.opendaylight.org/en/stable-nitrogen/', None) intersphinx_mapping['odl-carbon'] = ('https://docs.opendaylight.org/en/stable-carbon/', None) linkcheck_ignore = [ + 'http://localhost', + # Ignore ssh:// links from linkcheck + 'ssh:', # Ignore jenkins because it's often slow to respond. 'https://jenkins.opendaylight.org/releng', 'https://jenkins.opendaylight.org/sandbox', # The '#' in the path makes sphinx think it's an anchor 'https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder', + 'https://git.opendaylight.org/gerrit/#/c/', + 'https://git.opendaylight.org/gerrit/gitweb', + # URL returns a 403 Forbidden + 'https://www.osgi.org', + # Ignore anchors on github.com because linkcheck fails on them + '^https?://github.com/.*#', + # Ignore webchat anchors because '#' is not an anchor for this app + 'https://web.libera.chat/#', + # Ignore google docs anchors + 'https://docs.google.com/presentation/d/1bnwj8CrFGo5KekONYSeIHySdkoXZiewJxkHcZjXnzkQ/edit#slide=id.g17d8ae4d92_0_137', + # Ignore local static contents + '../_static/OpenDaylight-Technical-Charter-LFN-Projects-LLC-FINAL.pdf', + # Ignore IETF URLs often not reachable from Jenkins minions + # because of hosting connectivity issues + '^https?://tools.ietf.org/html/.*', ] +linkcheck_timeout = 300 nitpicky = True release = version +spelling_warning = True +spelling_exclude_patterns = ['release-notes/release-notes-*'] + html_context = { 'version_status': 'supported', } def setup(app): - app.add_stylesheet("css/ribbon.css") + app.add_css_file("css/ribbon.css")