Skip to content
Snippets Groups Projects
Select Git revision
  • cd65a8362b0a5ff236b7c36b840f5e01ed4a27a6
  • master default protected
  • installable
  • release-v0.1.5 protected
  • release-v0.1.4 protected
  • release-v0.1.3 protected
  • release-v0.1.2 protected
  • release-v0.1.1 protected
  • release-v0.1.0 protected
  • release-v0.0.10 protected
  • release-v0.0.9 protected
  • release-v0.0.8 protected
  • release-v0.0.7 protected
  • release-v0.0.6 protected
  • release-v0.0.5 protected
  • release-v0.0.4 protected
  • release-v0.0.3 protected
  • release-v0.0.2 protected
  • release-v0.0.1 protected
19 results

secrets.py

Blame
  • conf.py 4.13 KiB
    # Configuration file for the Sphinx documentation builder.
    #
    # This file only contains a selection of the most common options. For a full
    # list see the documentation:
    # https://www.sphinx-doc.org/en/master/usage/configuration.html
    
    # -- Path setup --------------------------------------------------------------
    
    # If extensions (or modules to document with autodoc) are in another directory,
    # add these directories to sys.path here. If the directory is relative to the
    # documentation root, use os.path.abspath to make it absolute, like shown here.
    #
    import os
    import sys
    
    sys.path.insert(0, os.path.abspath('../..'))
    
    import mlair
    
    # -- Project information -----------------------------------------------------
    
    project = 'MLAir'
    copyright = '2020, Lukas H Leufen, Felix Kleinert'
    author = 'Lukas H Leufen, Felix Kleinert'
    
    # The short X.Y version
    version = "v" + ".".join(mlair.__version__.split(".")[0:2])
    # The full version, including alpha/beta/rc tags
    release = "v" + mlair.__version__
    
    # -- General configuration ---------------------------------------------------
    
    # Add any Sphinx extension module names here, as strings. They can be
    # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
    # ones.
    extensions = [
        'sphinx.ext.autodoc',
        'sphinx.ext.intersphinx',
        'sphinx.ext.todo',
        'sphinx.ext.coverage',
        'sphinx.ext.imgmath',
        'sphinx.ext.ifconfig',
        # 'sphinx.ext.viewcode',
        'sphinx.ext.autosummary',
        'autoapi.extension',
        'sphinx.ext.napoleon',
        'sphinx_rtd_theme',
        'sphinx.ext.githubpages',
        #'recommonmark',
        'sphinx.ext.autosectionlabel',
        'sphinx_autodoc_typehints',  # must be loaded after napoleon
        'm2r2'
    ]
    
    # 2020-02-19 Begin
    # following instruction based on
    # https://stackoverflow.com/questions/2701998/sphinx-autodoc-is-not-automatic-enough
    autosummary_generate = True
    
    autoapi_type = 'python'
    autoapi_dirs = ['../../mlair/.']
    
    # Add any paths that contain templates here, relative to this directory.
    templates_path = ['_templates']
    
    # add asource file parser for markdown
    source_parsers = {
        '.md': 'recommonmark.parser.CommonMarkParser',
    }
    
    # The suffix(es) of source filenames.
    # You can specify multiple suffix as a list of string:
    #
    source_suffix = ['.rst', '.md']
    
    # The master toctree document.
    master_doc = 'index'
    
    # List of patterns, relative to source directory, that match files and
    # directories to ignore when looking for source files.
    # This pattern also affects html_static_path and html_extra_path.
    exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
    
    # -- Options for HTML output -------------------------------------------------
    
    # The theme to use for HTML and HTML Help pages.  See the documentation for
    # a list of builtin themes.
    #
    # html_theme = 'alabaster'
    # html_theme = 'bizstyle'
    # html_theme = 'classic'
    html_theme = 'sphinx_rtd_theme'
    
    
    # Add any paths that contain custom static files (such as style sheets) here,
    # relative to this directory. They are copied after the builtin static files,
    # so a file named "default.css" will overwrite the builtin "default.css".
    html_static_path = ['_static']
    
    # -- Options for LaTeX output ------------------------------------------------
    
    latex_elements = {
        # The paper size ('letterpaper' or 'a4paper').
        #
        # 'papersize': 'letterpaper',
    
        # The font size ('10pt', '11pt' or '12pt').
        #
        # 'pointsize': '10pt',
    
        # Additional stuff for the LaTeX preamble.
        #
        # 'preamble': '',
    
        # Latex figure (float) alignment
        #
        # 'figure_align': 'htbp',
    }
    
    # Grouping the document tree into LaTeX files. List of tuples
    # (source start file, target name, title,
    #  author, documentclass [howto, manual, or own class]).
    latex_documents = [
        (master_doc, 'mlair.tex', 'MLAir Documentation',
         author, 'manual'),
    ]
    
    # -- Options for intersphinx extension ---------------------------------------
    
    # Example configuration for intersphinx: refer to the Python standard library.
    intersphinx_mapping = {
        'python': ('https://docs.python.org/3', None),
        'pandas': ('http://pandas.pydata.org/pandas-docs/stable/', None),
        'numpy': ('https://docs.scipy.org/doc/numpy/', None),
        'matplotlib': ('https://matplotlib.org/', None)
    }