i@95: # -*- coding: utf-8 -*- i@95: # i@95: # Atmospheric lidar documentation build configuration file, created by i@95: # sphinx-quickstart on Thu Dec 7 15:45:39 2017. i@95: # i@95: # This file is execfile()d with the current directory set to its i@95: # containing dir. i@95: # i@95: # Note that not all possible configuration values are present in this i@95: # autogenerated file. i@95: # i@95: # All configuration values have a default; values that are commented out i@95: # serve to show the default. i@95: i@95: # If extensions (or modules to document with autodoc) are in another directory, i@95: # add these directories to sys.path here. If the directory is relative to the i@95: # documentation root, use os.path.abspath to make it absolute, like shown here. i@95: # i@95: import os i@95: import sys i@95: sys.path.insert(0, os.path.abspath('../')) i@95: i@95: i@98: # Mock modules for read the docs i@98: on_rtd = os.environ.get('READTHEDOCS') == 'True' i@98: i@98: if on_rtd: i@98: from mock import Mock as MagicMock i@98: i@98: class Mock(MagicMock): i@98: @classmethod i@98: def __getattr__(cls, name): i@98: return MagicMock() i@98: i@100: MOCK_MODULES = ['netCDF4', 'numpy', 'scipy', 'matplotlib', 'matplotlib.ticker'] i@98: sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) i@98: i@95: # -- General configuration ------------------------------------------------ i@95: i@95: # If your documentation needs a minimal Sphinx version, state it here. i@95: # i@95: # needs_sphinx = '1.0' i@95: i@95: # Add any Sphinx extension module names here, as strings. They can be i@95: # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom i@95: # ones. i@95: extensions = ['sphinx.ext.autodoc', i@95: 'sphinx.ext.intersphinx', i@95: 'sphinx.ext.todo', i@95: 'sphinx.ext.mathjax', i@95: 'sphinx.ext.viewcode'] i@95: i@95: # Add any paths that contain templates here, relative to this directory. i@95: templates_path = ['_templates'] i@95: i@95: # The suffix(es) of source filenames. i@95: # You can specify multiple suffix as a list of string: i@95: # i@95: # source_suffix = ['.rst', '.md'] i@95: source_suffix = '.rst' i@95: i@95: # The master toctree document. i@95: master_doc = 'index' i@95: i@95: # General information about the project. i@95: project = u'Atmospheric lidar' i@95: copyright = u'2017, Ioannis Binietoglou, Victor Nicolae' i@95: author = u'Ioannis Binietoglou, Victor Nicolae' i@95: i@95: # The version info for the project you're documenting, acts as replacement for i@95: # |version| and |release|, also used in various other places throughout the i@95: # built documents. i@95: # i@95: # The short X.Y version. i@95: version = u'0.2.11' i@95: # The full version, including alpha/beta/rc tags. i@95: release = u'0.2.11' i@95: i@95: # The language for content autogenerated by Sphinx. Refer to documentation i@95: # for a list of supported languages. i@95: # i@95: # This is also used if you do content translation via gettext catalogs. i@95: # Usually you set "language" from the command line for these cases. i@95: language = None i@95: i@95: # List of patterns, relative to source directory, that match files and i@95: # directories to ignore when looking for source files. i@95: # This patterns also effect to html_static_path and html_extra_path i@95: exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] i@95: i@95: # The name of the Pygments (syntax highlighting) style to use. i@95: pygments_style = 'sphinx' i@95: i@95: # If true, `todo` and `todoList` produce output, else they produce nothing. i@95: todo_include_todos = True i@95: i@95: i@95: # -- Options for HTML output ---------------------------------------------- i@95: i@95: # The theme to use for HTML and HTML Help pages. See the documentation for i@95: # a list of builtin themes. i@95: # i@95: html_theme = 'alabaster' i@95: i@95: # Theme options are theme-specific and customize the look and feel of a theme i@95: # further. For a list of options available for each theme, see the i@95: # documentation. i@95: # i@95: # html_theme_options = {} i@95: i@95: # Add any paths that contain custom static files (such as style sheets) here, i@95: # relative to this directory. They are copied after the builtin static files, i@95: # so a file named "default.css" will overwrite the builtin "default.css". i@95: html_static_path = ['_static'] i@95: i@95: # Custom sidebar templates, must be a dictionary that maps document names i@95: # to template names. i@95: # i@95: # This is required for the alabaster theme i@95: # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars i@95: html_sidebars = { i@95: '**': [ i@95: 'relations.html', # needs 'show_related': True theme option to display i@95: 'searchbox.html', i@95: ] i@95: } i@95: i@95: i@95: # -- Options for HTMLHelp output ------------------------------------------ i@95: i@95: # Output file base name for HTML help builder. i@95: htmlhelp_basename = 'Atmosphericlidardoc' i@95: i@95: i@95: # -- Options for LaTeX output --------------------------------------------- i@95: i@95: latex_elements = { i@95: # The paper size ('letterpaper' or 'a4paper'). i@95: # i@95: # 'papersize': 'letterpaper', i@95: i@95: # The font size ('10pt', '11pt' or '12pt'). i@95: # i@95: # 'pointsize': '10pt', i@95: i@95: # Additional stuff for the LaTeX preamble. i@95: # i@95: # 'preamble': '', i@95: i@95: # Latex figure (float) alignment i@95: # i@95: # 'figure_align': 'htbp', i@95: } i@95: i@95: # Grouping the document tree into LaTeX files. List of tuples i@95: # (source start file, target name, title, i@95: # author, documentclass [howto, manual, or own class]). i@95: latex_documents = [ i@95: (master_doc, 'Atmosphericlidar.tex', u'Atmospheric lidar Documentation', i@95: u'Ioannis Binietoglou, Victor Nicolae', 'manual'), i@95: ] i@95: i@95: i@95: # -- Options for manual page output --------------------------------------- i@95: i@95: # One entry per manual page. List of tuples i@95: # (source start file, name, description, authors, manual section). i@95: man_pages = [ i@95: (master_doc, 'atmosphericlidar', u'Atmospheric lidar Documentation', i@95: [author], 1) i@95: ] i@95: i@95: i@95: # -- Options for Texinfo output ------------------------------------------- i@95: i@95: # Grouping the document tree into Texinfo files. List of tuples i@95: # (source start file, target name, title, author, i@95: # dir menu entry, description, category) i@95: texinfo_documents = [ i@95: (master_doc, 'Atmosphericlidar', u'Atmospheric lidar Documentation', i@95: author, 'Atmosphericlidar', 'One line description of project.', i@95: 'Miscellaneous'), i@95: ] i@95: i@95: i@95: i@95: # -- Options for Epub output ---------------------------------------------- i@95: i@95: # Bibliographic Dublin Core info. i@95: epub_title = project i@95: epub_author = author i@95: epub_publisher = author i@95: epub_copyright = copyright i@95: i@95: # The unique identifier of the text. This can be a ISBN number i@95: # or the project homepage. i@95: # i@95: # epub_identifier = '' i@95: i@95: # A unique identification for the text. i@95: # i@95: # epub_uid = '' i@95: i@95: # A list of files that should not be packed into the epub file. i@95: epub_exclude_files = ['search.html'] i@95: i@95: i@95: i@95: # Example configuration for intersphinx: refer to the Python standard library. i@95: intersphinx_mapping = {'https://docs.python.org/': None}