docs/conf.py

   1 # Copyright 2016 - 2023, Cisco Systems, Inc. and the NFVbench project contributors
   2 # SPDX-License-Identifier: Apache-2.0
   3
   4 # Configuration file for the Sphinx documentation builder.
   5 #
   6 # This file only contains a selection of the most common options. For a full
   7 # list see the documentation:
   8 # https://www.sphinx-doc.org/en/master/usage/configuration.html
   9
  10 import pbr.version
  11
  12
  13 # -- Path setup --------------------------------------------------------------
  14
  15 # If extensions (or modules to document with autodoc) are in another directory,
  16 # add these directories to sys.path here. If the directory is relative to the
  17 # documentation root, use os.path.abspath to make it absolute, like shown here.
  18 #
  19 # import os
  20 # import sys
  21 # sys.path.insert(0, os.path.abspath('.'))
  22
  23
  24 # -- Project information -----------------------------------------------------
  25
  26 project = 'NFVbench'
  27 copyright = '2016 - 2023, Cisco Systems, Inc. and the NFVbench project contributors'
  28 author = 'Cisco Systems, Inc. and the NFVbench project contributors'
  29
  30 # -- Project version ---------------------------------------------------------
  31
  32 # The version info for the project you're documenting, acts as replacement for
  33 # |version| and |release|, also used in various other places throughout the
  34 # built documents.
  35 #
  36 # The short X.Y version.
  37 version = pbr.version.VersionInfo(project).version_string()
  38 # The full version, including alpha/beta/rc tags.
  39 release = pbr.version.VersionInfo(project).version_string_with_vcs()
  40
  41 # -- General configuration ---------------------------------------------------
  42
  43 # Add any Sphinx extension module names here, as strings. They can be
  44 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  45 # ones.
  46 extensions = [
  47 ]
  48
  49 # Add any paths that contain templates here, relative to this directory.
  50 templates_path = ['_templates']
  51
  52 # List of patterns, relative to source directory, that match files and
  53 # directories to ignore when looking for source files.
  54 # This pattern also affects html_static_path and html_extra_path.
  55 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  56
  57
  58 # -- Options for HTML output -------------------------------------------------
  59
  60 # The theme to use for HTML and HTML Help pages.  See the documentation for
  61 # a list of builtin themes.
  62 #
  63 html_theme = 'piccolo_theme'
  64
  65 # Add any paths that contain custom static files (such as style sheets) here,
  66 # relative to this directory. They are copied after the builtin static files,
  67 # so a file named "default.css" will overwrite the builtin "default.css".
  68 html_static_path = ['_static']