docs/conf.py

   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 # -- Project information -----------------------------------------------------
  18
  19 project = 'ONE(On-device Neural Engine)'
  20 copyright = '2020, Samsung Research & contributors'
  21 author = 'Samsung Research & contributors'
  22
  23 # The full version, including alpha/beta/rc tags
  24 release = '1.8.0'
  25
  26 # -- General configuration ---------------------------------------------------
  27
  28 # Add any Sphinx extension module names here, as strings. They can be
  29 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  30 # ones.
  31 extensions = ['recommonmark', 'sphinx_markdown_tables']
  32
  33 # Add any paths that contain templates here, relative to this directory.
  34 templates_path = ['_templates']
  35
  36 # List of patterns, relative to source directory, that match files and
  37 # directories to ignore when looking for source files.
  38 # This pattern also affects html_static_path and html_extra_path.
  39 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  40
  41 # -- Options for HTML output -------------------------------------------------
  42
  43 # The theme to use for HTML and HTML Help pages.  See the documentation for
  44 # a list of builtin themes.
  45 #
  46 html_theme = 'sphinx_rtd_theme'
  47
  48 # Add any paths that contain custom static files (such as style sheets) here,
  49 # relative to this directory. They are copied after the builtin static files,
  50 # so a file named "default.css" will overwrite the builtin "default.css".
  51 html_static_path = ['_static']