docs/etc/conf.py

   1 # SPDX-license-identifier: Apache-2.0
   2 ##############################################################################
   3 # Copyright (c) 2016 Linux Foundation and others.
   4 # All rights reserved. This program and the accompanying materials
   5 # are made available under the terms of the Apache License, Version 2.0
   6 # which accompanies this distribution, and is available at
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8 ##############################################################################
   9 '''
  10 Base configuration file for building OPNFV docs
  11
  12 You can override this configuration by putting 'conf.py' in the document
  13 directory (e.g. docs/how-to-use-docs/conf.py). If there is no 'conf.py'
  14 in the document directory, this file will be copied to that directory
  15 before the document builder jobs ('opnfv-docs-verify' and 'opnfv-docs-merge').
  16
  17 You may need python package installation for new sphinx extension.
  18 Install python package with 'pip' in your machine and add the extension to
  19 the 'extensions' list below to test the documentation build locally.
  20 If you feel that your extensions would be useful for other projects too,
  21 we encourage you to propose a change in the releng repository.
  22
  23 For further guidance see the https://wiki.opnfv.org/documentation/tools page.
  24 '''
  25
  26 extensions = ['sphinxcontrib.httpdomain',
  27               'sphinx.ext.autodoc',
  28               'sphinx.ext.viewcode',
  29               'sphinx.ext.napoleon']
  30
  31 needs_sphinx = '1.3'
  32 master_doc = 'index'
  33 pygments_style = 'sphinx'
  34
  35 html_use_index = False
  36 numfig = True
  37 html_logo = 'opnfv-logo.png'
  38
  39 latex_domain_indices = False
  40 latex_logo = 'opnfv-logo.png'