2 # -*- coding: utf-8 -*-
3 # SPDX-License-Identifier: EPL-1.0
4 ##############################################################################
5 # Copyright (c) 2018 The Linux Foundation and others.
7 # All rights reserved. This program and the accompanying materials
8 # are made available under the terms of the Eclipse Public License v1.0
9 # which accompanies this distribution, and is available at
10 # http://www.eclipse.org/legal/epl-v10.html
11 ##############################################################################
13 from docs_conf.conf import *
16 # Append to intersphinx_mapping
17 intersphinx_mapping['aaa'] = ('https://docs.opendaylight.org/projects/aaa/en/latest/', None)
18 intersphinx_mapping['controller'] = ('https://docs.opendaylight.org/projects/controller/en/latest/', None)
19 intersphinx_mapping['infrautils'] = ('https://docs.opendaylight.org/projects/infrautils/en/latest/', None)
20 intersphinx_mapping['mdsal'] = ('https://docs.opendaylight.org/projects/mdsal/en/latest/', None)
21 intersphinx_mapping['netconf'] = ('https://docs.opendaylight.org/projects/netconf/en/latest/', None)
22 intersphinx_mapping['odl-integration-test'] = ('https://docs.opendaylight.org/projects/integration-test/en/latest/', None)
23 intersphinx_mapping['odl-integration-packaging'] = ('https://docs.opendaylight.org/projects/integration-packaging/en/latest/', None)
24 intersphinx_mapping['odl-releng-builder'] = ('https://docs.opendaylight.org/projects/releng-builder/en/latest/', None)
25 intersphinx_mapping['opflex'] = ('https://docs.opendaylight.org/projects/opflex/en/latest/', None)
27 # Projects that have stable/branches
28 intersphinx_mapping['bgpcep'] = ('https://docs.opendaylight.org/projects/bgpcep/en/latest/', None)
29 intersphinx_mapping['daexim'] = ('https://docs.opendaylight.org/projects/daexim/en/latest/', None)
30 intersphinx_mapping['genius'] = ('https://docs.opendaylight.org/projects/genius/en/latest/', None)
31 intersphinx_mapping['integration-distribution'] = ('https://docs.opendaylight.org/projects/integration-distribution/en/latest/', None)
32 intersphinx_mapping['jsonrpc'] = ('https://docs.opendaylight.org/projects/jsonrpc/en/latest/', None)
33 intersphinx_mapping['lispflowmapping'] = ('https://docs.opendaylight.org/projects/lispflowmapping/en/latest/', None)
34 intersphinx_mapping['openflowplugin'] = ('https://docs.opendaylight.org/projects/openflowplugin/en/latest/', None)
35 intersphinx_mapping['ovsdb'] = ('https://docs.opendaylight.org/projects/ovsdb/en/latest/', None)
36 intersphinx_mapping['transportpce'] = ('https://docs.opendaylight.org/projects/transportpce/en/latest/', None)
38 # OpenDaylight Documentation Releases
39 intersphinx_mapping['odl-phosphorus'] = ('https://docs.opendaylight.org/en/latest/', None)
40 intersphinx_mapping['odl-silicon'] = ('https://docs.opendaylight.org/en/stable-silicon/', None)
41 intersphinx_mapping['odl-aluminium'] = ('https://docs.opendaylight.org/en/stable-aluminium/', None)
42 intersphinx_mapping['odl-magnesium'] = ('https://docs.opendaylight.org/en/stable-magnesium/', None)
43 intersphinx_mapping['odl-sodium'] = ('https://docs.opendaylight.org/en/stable-sodium/', None)
44 intersphinx_mapping['odl-neon'] = ('https://docs.opendaylight.org/en/stable-neon/', None)
45 intersphinx_mapping['odl-fluorine'] = ('https://docs.opendaylight.org/en/stable-fluorine/', None)
46 intersphinx_mapping['odl-oxygen'] = ('https://docs.opendaylight.org/en/stable-oxygen/', None)
47 intersphinx_mapping['odl-nitrogen'] = ('https://docs.opendaylight.org/en/stable-nitrogen/', None)
48 intersphinx_mapping['odl-carbon'] = ('https://docs.opendaylight.org/en/stable-carbon/', None)
52 # Ignore ssh:// links from linkcheck
54 # Ignore jenkins because it's often slow to respond.
55 'https://jenkins.opendaylight.org/releng',
56 'https://jenkins.opendaylight.org/sandbox',
57 # The '#' in the path makes sphinx think it's an anchor
58 'https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder',
59 'https://git.opendaylight.org/gerrit/#/c/',
60 'https://git.opendaylight.org/gerrit/gitweb',
61 # URL returns a 403 Forbidden
62 'https://www.osgi.org',
63 # Ignore anchors on github.com because linkcheck fails on them
64 '^https?://github.com/.*#',
65 # Ignore webchat anchors because '#' is not an anchor for this app
66 'https://web.libera.chat/#',
67 # Ignore google docs anchors
68 'https://docs.google.com/presentation/d/1bnwj8CrFGo5KekONYSeIHySdkoXZiewJxkHcZjXnzkQ/edit#slide=id.g17d8ae4d92_0_137',
69 # Ignore local static contents
70 '../_static/OpenDaylight-Technical-Charter-LFN-Projects-LLC-FINAL.pdf',
71 # Ignore IETF URLs often not reachable from Jenkins minions
72 # because of hosting connectivity issues
73 '^https?://tools.ietf.org/html/.*',
74 # anchors not correctly detected by sphinx on the gate
75 'http://checkstyle.sourceforge.net/config_coding.html#.*',
76 # this url often has connectivity issues on the gate
77 'https://www.mojohaus.org/animal-sniffer/animal-sniffer-maven-plugin/examples/checking-signatures.html',
79 linkcheck_timeout = 300
84 spelling_warning = True
85 spelling_exclude_patterns = ['release-notes/release-notes-*', 'release-notes/projects/*']
88 'version_status': 'supported',
91 # Helper for JIRA references
92 sys.path.append(os.path.abspath('ext'))
93 extensions.append('odl-jira')
96 app.add_css_file("css/ribbon.css")