docs/conf.py

Thu, 07 Dec 2017 16:54:41 +0200

author
Iannis <i.binietoglou@impworks.gr>
date
Thu, 07 Dec 2017 16:54:41 +0200
changeset 95
efa2d8e1a2e5
child 98
aacf4fcdd4dd
permissions
-rw-r--r--

New documentation files.

i@95 1 # -*- coding: utf-8 -*-
i@95 2 #
i@95 3 # Atmospheric lidar documentation build configuration file, created by
i@95 4 # sphinx-quickstart on Thu Dec 7 15:45:39 2017.
i@95 5 #
i@95 6 # This file is execfile()d with the current directory set to its
i@95 7 # containing dir.
i@95 8 #
i@95 9 # Note that not all possible configuration values are present in this
i@95 10 # autogenerated file.
i@95 11 #
i@95 12 # All configuration values have a default; values that are commented out
i@95 13 # serve to show the default.
i@95 14
i@95 15 # If extensions (or modules to document with autodoc) are in another directory,
i@95 16 # add these directories to sys.path here. If the directory is relative to the
i@95 17 # documentation root, use os.path.abspath to make it absolute, like shown here.
i@95 18 #
i@95 19 import os
i@95 20 import sys
i@95 21 sys.path.insert(0, os.path.abspath('../'))
i@95 22
i@95 23
i@95 24 # -- General configuration ------------------------------------------------
i@95 25
i@95 26 # If your documentation needs a minimal Sphinx version, state it here.
i@95 27 #
i@95 28 # needs_sphinx = '1.0'
i@95 29
i@95 30 # Add any Sphinx extension module names here, as strings. They can be
i@95 31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
i@95 32 # ones.
i@95 33 extensions = ['sphinx.ext.autodoc',
i@95 34 'sphinx.ext.intersphinx',
i@95 35 'sphinx.ext.todo',
i@95 36 'sphinx.ext.mathjax',
i@95 37 'sphinx.ext.viewcode']
i@95 38
i@95 39 # Add any paths that contain templates here, relative to this directory.
i@95 40 templates_path = ['_templates']
i@95 41
i@95 42 # The suffix(es) of source filenames.
i@95 43 # You can specify multiple suffix as a list of string:
i@95 44 #
i@95 45 # source_suffix = ['.rst', '.md']
i@95 46 source_suffix = '.rst'
i@95 47
i@95 48 # The master toctree document.
i@95 49 master_doc = 'index'
i@95 50
i@95 51 # General information about the project.
i@95 52 project = u'Atmospheric lidar'
i@95 53 copyright = u'2017, Ioannis Binietoglou, Victor Nicolae'
i@95 54 author = u'Ioannis Binietoglou, Victor Nicolae'
i@95 55
i@95 56 # The version info for the project you're documenting, acts as replacement for
i@95 57 # |version| and |release|, also used in various other places throughout the
i@95 58 # built documents.
i@95 59 #
i@95 60 # The short X.Y version.
i@95 61 version = u'0.2.11'
i@95 62 # The full version, including alpha/beta/rc tags.
i@95 63 release = u'0.2.11'
i@95 64
i@95 65 # The language for content autogenerated by Sphinx. Refer to documentation
i@95 66 # for a list of supported languages.
i@95 67 #
i@95 68 # This is also used if you do content translation via gettext catalogs.
i@95 69 # Usually you set "language" from the command line for these cases.
i@95 70 language = None
i@95 71
i@95 72 # List of patterns, relative to source directory, that match files and
i@95 73 # directories to ignore when looking for source files.
i@95 74 # This patterns also effect to html_static_path and html_extra_path
i@95 75 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
i@95 76
i@95 77 # The name of the Pygments (syntax highlighting) style to use.
i@95 78 pygments_style = 'sphinx'
i@95 79
i@95 80 # If true, `todo` and `todoList` produce output, else they produce nothing.
i@95 81 todo_include_todos = True
i@95 82
i@95 83
i@95 84 # -- Options for HTML output ----------------------------------------------
i@95 85
i@95 86 # The theme to use for HTML and HTML Help pages. See the documentation for
i@95 87 # a list of builtin themes.
i@95 88 #
i@95 89 html_theme = 'alabaster'
i@95 90
i@95 91 # Theme options are theme-specific and customize the look and feel of a theme
i@95 92 # further. For a list of options available for each theme, see the
i@95 93 # documentation.
i@95 94 #
i@95 95 # html_theme_options = {}
i@95 96
i@95 97 # Add any paths that contain custom static files (such as style sheets) here,
i@95 98 # relative to this directory. They are copied after the builtin static files,
i@95 99 # so a file named "default.css" will overwrite the builtin "default.css".
i@95 100 html_static_path = ['_static']
i@95 101
i@95 102 # Custom sidebar templates, must be a dictionary that maps document names
i@95 103 # to template names.
i@95 104 #
i@95 105 # This is required for the alabaster theme
i@95 106 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
i@95 107 html_sidebars = {
i@95 108 '**': [
i@95 109 'relations.html', # needs 'show_related': True theme option to display
i@95 110 'searchbox.html',
i@95 111 ]
i@95 112 }
i@95 113
i@95 114
i@95 115 # -- Options for HTMLHelp output ------------------------------------------
i@95 116
i@95 117 # Output file base name for HTML help builder.
i@95 118 htmlhelp_basename = 'Atmosphericlidardoc'
i@95 119
i@95 120
i@95 121 # -- Options for LaTeX output ---------------------------------------------
i@95 122
i@95 123 latex_elements = {
i@95 124 # The paper size ('letterpaper' or 'a4paper').
i@95 125 #
i@95 126 # 'papersize': 'letterpaper',
i@95 127
i@95 128 # The font size ('10pt', '11pt' or '12pt').
i@95 129 #
i@95 130 # 'pointsize': '10pt',
i@95 131
i@95 132 # Additional stuff for the LaTeX preamble.
i@95 133 #
i@95 134 # 'preamble': '',
i@95 135
i@95 136 # Latex figure (float) alignment
i@95 137 #
i@95 138 # 'figure_align': 'htbp',
i@95 139 }
i@95 140
i@95 141 # Grouping the document tree into LaTeX files. List of tuples
i@95 142 # (source start file, target name, title,
i@95 143 # author, documentclass [howto, manual, or own class]).
i@95 144 latex_documents = [
i@95 145 (master_doc, 'Atmosphericlidar.tex', u'Atmospheric lidar Documentation',
i@95 146 u'Ioannis Binietoglou, Victor Nicolae', 'manual'),
i@95 147 ]
i@95 148
i@95 149
i@95 150 # -- Options for manual page output ---------------------------------------
i@95 151
i@95 152 # One entry per manual page. List of tuples
i@95 153 # (source start file, name, description, authors, manual section).
i@95 154 man_pages = [
i@95 155 (master_doc, 'atmosphericlidar', u'Atmospheric lidar Documentation',
i@95 156 [author], 1)
i@95 157 ]
i@95 158
i@95 159
i@95 160 # -- Options for Texinfo output -------------------------------------------
i@95 161
i@95 162 # Grouping the document tree into Texinfo files. List of tuples
i@95 163 # (source start file, target name, title, author,
i@95 164 # dir menu entry, description, category)
i@95 165 texinfo_documents = [
i@95 166 (master_doc, 'Atmosphericlidar', u'Atmospheric lidar Documentation',
i@95 167 author, 'Atmosphericlidar', 'One line description of project.',
i@95 168 'Miscellaneous'),
i@95 169 ]
i@95 170
i@95 171
i@95 172
i@95 173 # -- Options for Epub output ----------------------------------------------
i@95 174
i@95 175 # Bibliographic Dublin Core info.
i@95 176 epub_title = project
i@95 177 epub_author = author
i@95 178 epub_publisher = author
i@95 179 epub_copyright = copyright
i@95 180
i@95 181 # The unique identifier of the text. This can be a ISBN number
i@95 182 # or the project homepage.
i@95 183 #
i@95 184 # epub_identifier = ''
i@95 185
i@95 186 # A unique identification for the text.
i@95 187 #
i@95 188 # epub_uid = ''
i@95 189
i@95 190 # A list of files that should not be packed into the epub file.
i@95 191 epub_exclude_files = ['search.html']
i@95 192
i@95 193
i@95 194
i@95 195 # Example configuration for intersphinx: refer to the Python standard library.
i@95 196 intersphinx_mapping = {'https://docs.python.org/': None}

mercurial