#!/usr/bin/env python3 # -*- coding: utf-8 -*- # # Intel nGraph library documentation build configuration file, created by # sphinx-quickstart on Mon Dec 25 13:04:12 2017. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. # 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 # Add path to nGraph Python API. sys.path.insert(0, os.path.abspath('../../../python')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. # needs_sphinx = '1.7.5' # 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.autosummary', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'breathe', ] # source_suffix = '.rst' source_suffix = ['.rst', '.md'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] static_path = ['static'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The master toctree document. master_doc = 'index' # General information about the project. project = u'nGraph Compiler stack' copyright = '2018-2019, Intel Corporation' author = 'Intel Corporation' # License specifics see LICENSE of component # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = '0.20' # The Documentation full version, including alpha/beta/rc tags. Some features # available in the latest code will not necessarily be documented first release = '0.20.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = 'en' # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path exclude_patterns = [] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True # -- Options for HTML output ---------------------------------------------- html_title = 'nGraph Compiler stack Documentation' html_theme = 'ngraph_theme' # html_theme_options = {} html_theme_path = ["../"] if tags.has('release'): is_release = True docs_title = 'Docs / %s' %(version) %(release) else: is_release = False docs_title = 'Docs / Latest' # borrow this from the zephyr docs theme html_context = { # 'show_license': html_show_license, we have a custom footer to attribute # RTD, WTD, and Sphinx contributors; so we do not enable this 'docs_title': docs_title, 'is_release': is_release, 'theme_logo_only': False, 'current_version': version, 'versions': ( ("latest", "../"), ("0.19.0", "/0.19.0/"), #not yet sure how we'll do this ("0.18.0", "/0.18.0/"), ("0.17.0", "/0.17.0/"), ("0.16.0", "/0.16.0/"), ) } html_logo = '../ngraph_theme/static/favicon.ico' # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. html_favicon = '../ngraph_theme/static/favicon.ico' # 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 = ['../ngraph_theme/static'] # Add any paths that contain custom themes here, relative to this directory. # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # This is required for the alabaster theme # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars html_sidebars = { '**': [ 'relations.html', # needs 'show_related': True theme option to display 'searchbox.html', ] } # Custom added feature to allow redirecting old URLs # # list of tuples (old_url, new_url) for pages to redirect # (URLs should be relative to document root, only) html_redirect_pages = [ ('backends', 'backend-support/index'), ('core/core', 'core/overview.rst'), ('core/fusion', 'core/fusion/index'), ('frameworks/mxnet', 'frameworks/mxnet_intg.rst'), ('frameworks/onnx', 'frameworks/onnx_intg.rst'), ('frameworks/tensorflow', 'frameworks/tensorflow_connect.rst'), ('frameworks/paddle', 'frameworks/paddle_integ.rst'), ('inspection/inspection', 'inspection/index'), ('releases/release-notes', 'releases/index'), # ('getting_started/getting_starting', 'getting_started/index'), ('project/project', 'project/index'), ('python_api/', 'python_api/index'), ] # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'IntelnGraphlibrarydoc' # -- 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, 'nGraphCompilerStack.tex', 'nGraph Compiler Stack Documentation', 'Intel Corporation', 'manual'), ] # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'ngraphcompiler', 'nGraph Compiler stack', [author], 1) ] # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'IntelnGraphlibrary', 'Intel nGraph Library', author, 'IntelnGraphlibrary', 'Documentation for Intel nGraph Library code base', 'Miscellaneous'), ] breathe_projects = { "ngraph": "../../doxygen/xml", } rst_epilog = u""" .. |codename| replace:: Intel nGraph .. |project| replace:: Intel nGraph Library .. |InG| replace:: IntelĀ® nGraph .. |copy| unicode:: U+000A9 .. COPYRIGHT SIGN :ltrim: .. |deg| unicode:: U+000B0 .. DEGREE SIGN :ltrim: .. |plusminus| unicode:: U+000B1 .. PLUS-MINUS SIGN :rtrim: .. |micro| unicode:: U+000B5 .. MICRO SIGN :rtrim: .. |trade| unicode:: U+02122 .. TRADEMARK SIGN :ltrim: .. |reg| unicode:: U+000AE .. REGISTERED TRADEMARK SIGN :ltrim: """ # -- autodoc Extension configuration -------------------------------------- autodoc_mock_imports = ['ngraph.impl', 'ngraph.utils']