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

     2 #

     3 # elog2labfolder documentation build configuration file, created by

     4 # sphinx-quickstart on Mon Jan  8 16:34:32 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 = ['sphinx.ext.autodoc',

    34     'sphinx.ext.doctest',

    35     'sphinx.ext.intersphinx',

    36     'sphinx.ext.todo',

    37     'sphinx.ext.coverage',

    38     'sphinx.ext.mathjax',

    39     'sphinx.ext.viewcode',

    40     'sphinx.ext.githubpages']

    41 

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

    43 templates_path = ['_templates']

    44 

    45 # The suffix(es) of source filenames.

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

    47 #

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

    49 source_suffix = '.rst'

    50 

    51 # The master toctree document.

    52 master_doc = 'index'

    53 

    54 # General information about the project.

    55 project = u'Labfolder am FHI'

    56 copyright = u'2018, Stefan Weiher'

    57 author = u'Stefan Weiher'

    58 

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

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

    61 # built documents.

    62 #

    63 # The short X.Y version.

    64 version = u'1.0'

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

    66 release = u'1.0'

    67 

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

    69 # for a list of supported languages.

    70 #

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

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

    73 language = None

    74 

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

    76 # directories to ignore when looking for source files.

    77 # This patterns also effect to html_static_path and html_extra_path

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

    79 

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

    81 pygments_style = 'sphinx'

    82 

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

    84 todo_include_todos = True

    85 

    86 

    87 # -- Options for HTML output ----------------------------------------------

    88 

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

    90 # a list of builtin themes.

    91 #

    92 html_theme = 'alabaster'

    93 

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

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

    96 # documentation.

    97 #

    98 # html_theme_options = {}

    99 

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

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

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

   103 html_static_path = ['_static']

   104 

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

   106 # to template names.

   107 #

   108 # This is required for the alabaster theme

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

   110 html_sidebars = {

   111     '**': [

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

   113         'searchbox.html',

   114     ]

   115 }

   116 

   117 

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

   119 

   120 # Output file base name for HTML help builder.

   121 htmlhelp_basename = 'elog2labfolderdoc'

   122 

   123 

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

   125 

   126 latex_elements = {

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

   128     #

   129     # 'papersize': 'letterpaper',

   130 

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

   132     #

   133     # 'pointsize': '10pt',

   134 

   135     # Additional stuff for the LaTeX preamble.

   136     #

   137     # 'preamble': '',

   138 

   139     # Latex figure (float) alignment

   140     #

   141     # 'figure_align': 'htbp',

   142 }

   143 

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

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

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

   147 latex_documents = [

   148     (master_doc, 'elog2labfolder.tex', u'elog2labfolder Documentation',

   149      u'Stefan Weiher', 'manual'),

   150 ]

   151 

   152 

   153 # -- Options for manual page output ---------------------------------------

   154 

   155 # One entry per manual page. List of tuples

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

   157 man_pages = [

   158     (master_doc, 'elog2labfolder', u'elog2labfolder Documentation',

   159      [author], 1)

   160 ]

   161 

   162 

   163 # -- Options for Texinfo output -------------------------------------------

   164 

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

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

   167 #  dir menu entry, description, category)

   168 texinfo_documents = [

   169     (master_doc, 'elog2labfolder', u'elog2labfolder Documentation',

   170      author, 'elog2labfolder', 'One line description of project.',

   171      'Miscellaneous'),

   172 ]

   173 

   174 

   175 

   176 

   177 # Example configuration for intersphinx: refer to the Python standard library.

   178 intersphinx_mapping = {'https://docs.python.org/': None}