github.com/containers/podman/v2@v2.2.2-0.20210501105131-c1e07d070c4c/docs/source/conf.py (about)

     1  # Configuration file for the Sphinx documentation builder.
     2  #
     3  # This file only contains a selection of the most common options. For a full
     4  # list see the documentation:
     5  # https://www.sphinx-doc.org/en/master/usage/configuration.html
     6  
     7  # -- Path setup --------------------------------------------------------------
     8  
     9  # If extensions (or modules to document with autodoc) are in another directory,
    10  # add these directories to sys.path here. If the directory is relative to the
    11  # documentation root, use os.path.abspath to make it absolute, like shown here.
    12  #
    13  # import os
    14  # import sys
    15  # sys.path.insert(0, os.path.abspath('.'))
    16  
    17  
    18  # -- Project information -----------------------------------------------------
    19  
    20  project = "Podman"
    21  copyright = "2019, team"
    22  author = "team"
    23  
    24  
    25  # -- General configuration ---------------------------------------------------
    26  
    27  # Add any Sphinx extension module names here, as strings. They can be
    28  # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
    29  # ones.
    30  extensions = [
    31      "sphinx_markdown_tables",
    32  ]
    33  
    34  source_parsers = {
    35      ".md": "recommonmark.parser.CommonMarkParser",
    36  }
    37  
    38  
    39  # Add any paths that contain templates here, relative to this directory.
    40  templates_path = ["_templates"]
    41  
    42  # List of patterns, relative to source directory, that match files and
    43  # directories to ignore when looking for source files.
    44  # This pattern also affects html_static_path and html_extra_path.
    45  exclude_patterns = []
    46  
    47  master_doc = "index"
    48  
    49  # -- Options for HTML output -------------------------------------------------
    50  
    51  # The theme to use for HTML and HTML Help pages.  See the documentation for
    52  # a list of builtin themes.
    53  #
    54  html_theme = "alabaster"
    55  
    56  # Add any paths that contain custom static files (such as style sheets) here,
    57  # relative to this directory. They are copied after the builtin static files,
    58  # so a file named "default.css" will overwrite the builtin "default.css".
    59  html_static_path = ["_static"]
    60  
    61  html_css_files = [
    62      "custom.css",
    63  ]
    64  
    65  # -- Extension configuration -------------------------------------------------