docs/etc/conf.py

   1 '''
   2 Base configuration file for building OPNFV docs
   3
   4 You can override this configuration by putting 'conf.py' in the document
   5 directory (e.g. docs/how-to-use-docs/conf.py). If there is no 'conf.py'
   6 in the document directory, this file will be copied to that directory
   7 before the document builder jobs ('opnfv-docs-verify' and 'opnfv-docs-merge').
   8
   9 You may need python package installation for new sphinx extension.
  10 Install python package with 'pip' in your machine and add the extension to
  11 the 'extensions' list below to test the documentation build locally.
  12 If you feel that your extensions would be useful for other projects too,
  13 we encourage you to propose a change in the releng repository.
  14
  15 For further guidance see the https://wiki.opnfv.org/documentation/tools page.
  16 '''
  17
  18 extensions = ['sphinxcontrib.httpdomain',
  19               'sphinx.ext.autodoc',
  20               'sphinx.ext.viewcode',
  21               'sphinx.ext.napoleon']
  22
  23 needs_sphinx = '1.3'
  24 master_doc = 'index'
  25 pygments_style = 'sphinx'
  26
  27 html_use_index = False
  28 numfig = True
  29 html_logo = 'opnfv-logo.png'
  30
  31 latex_domain_indices = False
  32 latex_logo = 'opnfv-logo.png'