docs/docs/conf.py at master · opendaylight/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# SPDX-License-Identifier: EPL-1.0
##############################################################################
# Copyright (c) 2018 The Linux Foundation and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at
# http://www.eclipse.org/legal/epl-v10.html
##############################################################################

from docs_conf.conf import *
import sys, os, csv


def update_intersphinx_mapping():
    with open('../projects_list.tsv') as fd:
        rd = csv.reader(fd, delimiter="\t", quotechar='"')
        for row in rd:
            if row:
                # Validate row has at least 2 columns
                if len(row) < 2:
                    continue

                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-chromium'] = ('https://docs.opendaylight.org/en/latest/', None)
intersphinx_mapping['odl-vanadium'] = ('https://docs.opendaylight.org/en/stable-vanadium/', None)
intersphinx_mapping['odl-titanium'] = ('https://docs.opendaylight.org/en/stable-titanium/', None)
intersphinx_mapping['odl-scandium'] = ('https://docs.opendaylight.org/en/stable-scandium/', None)
intersphinx_mapping['odl-calcium'] = ('https://docs.opendaylight.org/en/stable-calcium/', 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)
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/.*',
    # https://wiki-archive.opendaylight.org is usually slow to respond
    '^https://wiki-archive.opendaylight.org/.*',
    # URL returns a 403 Forbidden
    '^https://checkstyle.sourceforge.net.*',
    # this url often has connectivity issues on the gate
    'https://www.mojohaus.org/animal-sniffer/animal-sniffer-maven-plugin/examples/checking-signatures.html',
    # this url often has connectivity issues on the gate
    '^https://cwiki.apache.org/confluence/display/PEKKO/.*',
    # this url often has connectivity issues on the gate
    'https://wiki-archive.opendaylight.org/images/c/ca/Profile-Java-ODL.xml.zip',
    #Ignore announce page link till it is up
    'https://www.opendaylight.org/current-release-vanadium',
    'https://www.opendaylight.org/current-release-titanium',
    # Ignore JIRA URLs that often timeout during linkcheck
    '^https://lf-opendaylight.atlassian.net/.*',
]
# Linkcheck configuration for better performance and reliability
linkcheck_timeout = 60  # Timeout per link (reduced from 300 to fail fast)
linkcheck_retries = 2  # Retry failed links
linkcheck_workers = 5  # Parallel workers (default)
linkcheck_rate_limit_timeout = 60.0  # Wait time after rate limit

nitpicky = True
release = version

spelling_warning = True
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")