docs/conf.py

   1 #!/usr/bin/env python3
   2 # -*- coding: utf-8 -*-
   3 # SPDX-License-Identifier: EPL-1.0
   4 ##############################################################################
   5 # Copyright (c) 2018 The Linux Foundation and others.
   6 #
   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 ##############################################################################
  12
  13 from docs_conf.conf import *
  14
  15 # Append to intersphinx_mapping
  16 intersphinx_mapping['odl-integration-test'] = ('http://docs.opendaylight.org/projects/integration-test/en/latest/', None)
  17 intersphinx_mapping['odl-integration-distribution'] = ('http://docs.opendaylight.org/projects/integration-distribution/en/latest/', None)
  18 intersphinx_mapping['odl-integration-packaging'] = ('http://docs.opendaylight.org/projects/integration-packaging/en/latest/', None)
  19 intersphinx_mapping['odl-releng-builder'] = ('http://docs.opendaylight.org/projects/releng-builder/en/latest/', None)
  20
  21 # Projects that have stable/branches
  22 intersphinx_mapping['coe'] = ('http://docs.opendaylight.org/projects/coe/en/latest/', None)
  23 intersphinx_mapping['genius'] = ('http://docs.opendaylight.org/projects/genius/en/latest/', None)
  24 intersphinx_mapping['infrautils'] = ('http://docs.opendaylight.org/projects/infrautils/en/latest/', None)
  25 intersphinx_mapping['netvirt'] = ('http://docs.opendaylight.org/projects/netvirt/en/latest/', None)
  26 intersphinx_mapping['openflowplugin'] = ('http://docs.opendaylight.org/projects/openflowplugin/en/latest/', None)
  27
  28 # OpenDaylight Documentation Releases
  29 intersphinx_mapping['odl-oxygen'] = ('http://docs.opendaylight.org/en/stable-oxygen/', None)
  30 intersphinx_mapping['odl-nitrogen'] = ('http://docs.opendaylight.org/en/stable-nitrogen/', None)
  31 intersphinx_mapping['odl-carbon'] = ('http://docs.opendaylight.org/en/stable-carbon/', None)
  32
  33 linkcheck_ignore = [
  34     # Ignore jenkins because it's often slow to respond.
  35     'https://jenkins.opendaylight.org/releng',
  36     'https://jenkins.opendaylight.org/sandbox',
  37     # The '#' in the path makes sphinx think it's an anchor
  38     'https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder',
  39 ]
  40
  41 nitpicky = True
  42 release = version
  43
  44 html_context = {
  45     'version_status': 'supported',
  46 }
  47
  48 def setup(app):
  49     app.add_stylesheet("css/ribbon.css")