docs/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Acumos Common Data Service documentation build configuration file, created by
   4 # sphinx-quickstart on Wed Nov  8 08:11:26 2017.
   5 #
   6 # This file is execfile()d with the current directory set to its
   7 # containing dir.
   8 #
   9 # Note that not all possible configuration values are present in this
  10 # autogenerated file.
  11 #
  12 # All configuration values have a default; values that are commented out
  13 # serve to show the default.
  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 # -- General configuration ------------------------------------------------
  25
  26 # If your documentation needs a minimal Sphinx version, state it here.
  27 #
  28 # needs_sphinx = '1.0'
  29
  30 # Add any Sphinx extension module names here, as strings. They can be
  31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  32 # ones.
  33 extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.graphviz', 'sphinx.ext.todo', 'sphinx.ext.imgmath', 'sphinx.ext.viewcode', 'sphinx.ext.ifconfig', 'sphinx.ext.todo', 'sphinxcontrib.swaggerdoc' ]
  34
  35 # Add any paths that contain templates here, relative to this directory.
  36 templates_path = ['_templates']
  37
  38 # The suffix(es) of source filenames.
  39 # You can specify multiple suffix as a list of string:
  40 #
  41 # source_suffix = ['.rst', '.md']
  42 source_suffix = '.rst'
  43
  44 # The master toctree document.
  45 master_doc = 'index'
  46
  47 # General information about the project.
  48 project = u'Acumos Common Data Service'
  49 copyright = u'2017, Acumos'
  50 author = u'Acumos'
  51
  52 # The version info for the project you're documenting, acts as replacement for
  53 # |version| and |release|, also used in various other places throughout the
  54 # built documents.
  55 #
  56 # The short X.Y version.
  57 version = u''
  58 # The full version, including alpha/beta/rc tags.
  59 release = u''
  60
  61 # The language for content autogenerated by Sphinx. Refer to documentation
  62 # for a list of supported languages.
  63 #
  64 # This is also used if you do content translation via gettext catalogs.
  65 # Usually you set "language" from the command line for these cases.
  66 language = None
  67
  68 # List of patterns, relative to source directory, that match files and
  69 # directories to ignore when looking for source files.
  70 # This patterns also effect to html_static_path and html_extra_path
  71 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  72
  73 # The name of the Pygments (syntax highlighting) style to use.
  74 pygments_style = 'sphinx'
  75
  76 # If true, `todo` and `todoList` produce output, else they produce nothing.
  77 todo_include_todos = False
  78
  79
  80 # -- Options for HTML output ----------------------------------------------
  81
  82 # The theme to use for HTML and HTML Help pages.  See the documentation for
  83 # a list of builtin themes.
  84 #
  85 html_theme = 'alabaster'
  86
  87 # Theme options are theme-specific and customize the look and feel of a theme
  88 # further.  For a list of options available for each theme, see the
  89 # documentation.
  90 #
  91 # html_theme_options = {}
  92
  93 # Add any paths that contain custom static files (such as style sheets) here,
  94 # relative to this directory. They are copied after the builtin static files,
  95 # so a file named "default.css" will overwrite the builtin "default.css".
  96 html_static_path = ['_static']
  97
  98 # Custom sidebar templates, must be a dictionary that maps document names
  99 # to template names.
 100 #
 101 # This is required for the alabaster theme
 102 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
 103 html_sidebars = {
 104     '**': [
 105         'relations.html',  # needs 'show_related': True theme option to display
 106         'searchbox.html',
 107     ]
 108 }
 109
 110
 111 # -- Options for HTMLHelp output ------------------------------------------
 112
 113 # Output file base name for HTML help builder.
 114 htmlhelp_basename = 'AcumosCommonDataServicedoc'
 115
 116
 117 # -- Options for LaTeX output ---------------------------------------------
 118
 119 latex_elements = {
 120     # The paper size ('letterpaper' or 'a4paper').
 121     #
 122     # 'papersize': 'letterpaper',
 123
 124     # The font size ('10pt', '11pt' or '12pt').
 125     #
 126     # 'pointsize': '10pt',
 127
 128     # Additional stuff for the LaTeX preamble.
 129     #
 130     # 'preamble': '',
 131
 132     # Latex figure (float) alignment
 133     #
 134     # 'figure_align': 'htbp',
 135 }
 136
 137 # Grouping the document tree into LaTeX files. List of tuples
 138 # (source start file, target name, title,
 139 #  author, documentclass [howto, manual, or own class]).
 140 latex_documents = [
 141     (master_doc, 'AcumosCommonDataService.tex', u'Acumos Common Data Service Documentation',
 142      u'Acumos', 'manual'),
 143 ]
 144
 145
 146 # -- Options for manual page output ---------------------------------------
 147
 148 # One entry per manual page. List of tuples
 149 # (source start file, name, description, authors, manual section).
 150 man_pages = [
 151     (master_doc, 'acumoscommondataservice', u'Acumos Common Data Service Documentation',
 152      [author], 1)
 153 ]
 154
 155
 156 # -- Options for Texinfo output -------------------------------------------
 157
 158 # Grouping the document tree into Texinfo files. List of tuples
 159 # (source start file, target name, title, author,
 160 #  dir menu entry, description, category)
 161 texinfo_documents = [
 162     (master_doc, 'AcumosCommonDataService', u'Acumos Common Data Service Documentation',
 163      author, 'AcumosCommonDataService', 'One line description of project.',
 164      'Miscellaneous'),
 165 ]
 166
 167
 168