143 lines
4.4 KiB
Python
143 lines
4.4 KiB
Python
# 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
|
|
import json
|
|
import shutil
|
|
from sphinx.util import logging
|
|
from json import JSONDecodeError
|
|
from sphinx.ext.autodoc import ClassDocumenter
|
|
|
|
|
|
sys.path.insert(0, os.path.abspath('doxyrest-sphinx'))
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'OpenVINO™'
|
|
copyright = '2021, Intel®'
|
|
author = 'Intel®'
|
|
|
|
language = 'en'
|
|
|
|
# -- 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_inline_tabs',
|
|
'sphinx_copybutton',
|
|
'doxyrest',
|
|
'cpplexer',
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.autosummary',
|
|
'sphinx_sitemap'
|
|
]
|
|
|
|
html_baseurl = 'https://docs.openvino.ai/latest/'
|
|
|
|
sitemap_url_scheme = "{link}"
|
|
|
|
html_favicon = '_static/favicon.ico'
|
|
autodoc_default_flags = ['members']
|
|
autosummary_generate = True
|
|
autosummary_imported_members = True
|
|
|
|
html_logo = '_static/logo.svg'
|
|
html_copy_source = False
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# 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', 'openvino/inference-engine']
|
|
|
|
|
|
# -- 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 = "openvino_sphinx_theme"
|
|
|
|
html_theme_path = ['_themes']
|
|
|
|
html_theme_options = {
|
|
"navigation_depth": 5,
|
|
"use_edit_page_button": True,
|
|
"github_url": "https://github.com/openvinotoolkit/openvino",
|
|
}
|
|
|
|
html_context = {
|
|
'current_language': 'English',
|
|
'languages': (('English', '/latest'), ('Chinese', '/cn/latest'))
|
|
}
|
|
|
|
repositories = {
|
|
'openvino': {
|
|
'github_user': 'openvinotoolkit',
|
|
'github_repo': 'openvino',
|
|
'github_version': 'master',
|
|
'host_url': 'https://github.com'
|
|
},
|
|
'open_model_zoo': {
|
|
'github_user': 'openvinotoolkit',
|
|
'github_repo': 'open_model_zoo',
|
|
'github_version': 'master',
|
|
'host_url': 'https://github.com'
|
|
}
|
|
}
|
|
|
|
try:
|
|
doxygen_mapping_file = '@DOXYGEN_MAPPING_FILE@'
|
|
with open(doxygen_mapping_file, 'r', encoding='utf-8') as f:
|
|
doxygen_mapping_file = json.load(f)
|
|
except JSONDecodeError:
|
|
doxygen_mapping_file = dict()
|
|
except FileNotFoundError:
|
|
doxygen_mapping_file = dict()
|
|
|
|
# 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']
|
|
|
|
# monkeypatch sphinx api doc to prevent showing inheritance from object and enum.Enum
|
|
add_line = ClassDocumenter.add_line
|
|
|
|
def add_line_no_base_object(self, line, *args, **kwargs):
|
|
if line.strip() in ['Bases: :class:`object`', 'Bases: :class:`enum.Enum`']:
|
|
return
|
|
else:
|
|
add_line(self, line, *args, **kwargs)
|
|
|
|
|
|
ClassDocumenter.add_line = add_line_no_base_object
|
|
|
|
|
|
def setup(app):
|
|
logger = logging.getLogger(__name__)
|
|
app.add_config_value('doxygen_mapping_file', doxygen_mapping_file, rebuild=True)
|
|
app.add_config_value('repositories', repositories, rebuild=True)
|
|
app.add_css_file('css/viewer.min.css')
|
|
app.add_css_file('css/custom.css')
|
|
app.add_js_file('js/viewer.min.js')
|
|
app.add_js_file('js/custom.js')
|
|
app.add_js_file('js/graphs.js')
|
|
try:
|
|
shutil.copytree(os.path.join(app.srcdir, 'csv'), os.path.join(app.outdir, 'csv'), dirs_exist_ok=True)
|
|
except FileNotFoundError:
|
|
logger.warning('csv directory not found.')
|