1 # -*- coding: utf-8 -*-

     2 #

     3 # Q-Cluster documentation build configuration file, created by

     4 # sphinx-quickstart on Fri Jan  5 23:03:19 2018.

     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 = [

    34 	'sphinxcontrib.plantuml',

    35 	'sphinx.ext.graphviz'

    36 ]

    37 

    38 # Add any paths that contain templates here, relative to this directory.

    39 templates_path = ['_templates']

    40 

    41 # The suffix(es) of source filenames.

    42 # You can specify multiple suffix as a list of string:

    43 #

    44 # source_suffix = ['.rst', '.md']

    45 source_suffix = '.rst'

    46 

    47 # The master toctree document.

    48 master_doc = 'index'

    49 

    50 # General information about the project.

    51 project = u'FHI-FEL'

    52 copyright = u'2018, Heinz Junkes'

    53 author = u'Heinz Junkes'

    54 

    55 # The version info for the project you're documenting, acts as replacement for

    56 # |version| and |release|, also used in various other places throughout the

    57 # built documents.

    58 #

    59 # The short X.Y version.

    60 version = u'0.0.1'

    61 # The full version, including alpha/beta/rc tags.

    62 release = u'0.0.1'

    63 

    64 # The language for content autogenerated by Sphinx. Refer to documentation

    65 # for a list of supported languages.

    66 #

    67 # This is also used if you do content translation via gettext catalogs.

    68 # Usually you set "language" from the command line for these cases.

    69 language = None

    70 

    71 # List of patterns, relative to source directory, that match files and

    72 # directories to ignore when looking for source files.

    73 # This patterns also effect to html_static_path and html_extra_path

    74 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

    75 

    76 # The name of the Pygments (syntax highlighting) style to use.

    77 pygments_style = 'sphinx'

    78 

    79 # If true, `todo` and `todoList` produce output, else they produce nothing.

    80 todo_include_todos = False

    81 

    82 

    83 # -- Options for HTML output ----------------------------------------------

    84 

    85 # The theme to use for HTML and HTML Help pages.  See the documentation for

    86 # a list of builtin themes.

    87 #

    88 #html_theme = 'alabaster'

    89 

    90 # Theme options are theme-specific and customize the look and feel of a theme

    91 # further.  For a list of options available for each theme, see the

    92 # documentation.

    93 #

    94 # html_theme_options = {}

    95 

    96 # Add any paths that contain custom static files (such as style sheets) here,

    97 # relative to this directory. They are copied after the builtin static files,

    98 # so a file named "default.css" will overwrite the builtin "default.css".

    99 html_static_path = ['_static']

   100 

   101 # Custom sidebar templates, must be a dictionary that maps document names

   102 # to template names.

   103 #

   104 # This is required for the alabaster theme

   105 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars

   106 html_sidebars = {

   107     '**': [

   108         'relations.html',  # needs 'show_related': True theme option to display

   109         'searchbox.html',

   110     ]

   111 }

   112 

   113 # Read the doc theme

   114 html_theme = "sphinx_rtd_theme"

   115 html_theme_path = ["_themes", ]

   116 

   117 

   118 # -- Options for HTMLHelp output ------------------------------------------

   119 

   120 # Output file base name for HTML help builder.

   121 htmlhelp_basename = 'FHI-FELdoc'

   122 

   123 

   124 # -- Options for LaTeX output ---------------------------------------------

   125 

   126 latex_elements = {

   127     # The paper size ('letterpaper' or 'a4paper').

   128     #

   129     # 'papersize': 'letterpaper',

   130     'papersize': 'a4paper',

   131 

   132     # The font size ('10pt', '11pt' or '12pt').

   133     #

   134     # 'pointsize': '10pt',

   135 

   136     # Additional stuff for the LaTeX preamble.

   137     #

   138     # 'preamble': '',

   139 

   140     # Latex figure (float) alignment

   141     #

   142     # 'figure_align': 'htbp',

   143 }

   144 

   145 # Grouping the document tree into LaTeX files. List of tuples

   146 # (source start file, target name, title,

   147 #  author, documentclass [howto, manual, or own class]).

   148 latex_documents = [

   149     (master_doc, 'FHI-FEL.tex', u'FHI-FEL Documentation',

   150      u'Heinz Junkes', 'manual'),

   151 ]

   152 

   153 

   154 # -- Options for manual page output ---------------------------------------

   155 

   156 # One entry per manual page. List of tuples

   157 # (source start file, name, description, authors, manual section).

   158 man_pages = [

   159     (master_doc, 'FHI-FEL', u'FHI-FEL Documentation',

   160      [author], 1)

   161 ]

   162 

   163 

   164 # -- Options for Texinfo output -------------------------------------------

   165 

   166 # Grouping the document tree into Texinfo files. List of tuples

   167 # (source start file, target name, title, author,

   168 #  dir menu entry, description, category)

   169 texinfo_documents = [

   170     (master_doc, 'FHI-FEL', u'FHI-FEL Documentation',

   171      author, 'FHI-FEL', 'One line description of project.',

   172      'Miscellaneous'),

   173 ]

   174 

   175 

   176 plantuml = '/usr/local/bin/plantuml'