|
- # 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 subprocess
- import sys
-
- sys.path.insert(0, os.path.abspath('..'))
-
- # -- Project information -----------------------------------------------------
-
- project = 'MMDetection'
- copyright = '2018-2020, OpenMMLab'
- author = 'MMDetection Authors'
- version_file = '../mmdet/version.py'
-
-
- def get_version():
- with open(version_file, 'r') as f:
- exec(compile(f.read(), version_file, 'exec'))
- return locals()['__version__']
-
-
- # The full version, including alpha/beta/rc tags
- release = get_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.napoleon',
- 'sphinx.ext.viewcode',
- 'recommonmark',
- 'sphinx_markdown_tables',
- ]
-
- autodoc_mock_imports = [
- 'matplotlib', 'pycocotools', 'terminaltables', 'mmdet.version', 'mmcv.ops'
- ]
-
- # Add any paths that contain templates here, relative to this directory.
- templates_path = ['_templates']
-
- # The suffix(es) of source filenames.
- # You can specify multiple suffix as a list of string:
- #
- source_suffix = {
- '.rst': 'restructuredtext',
- '.md': 'markdown',
- }
-
- # 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 = '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']
-
-
- def builder_inited_handler(app):
- subprocess.run(['./stat.py'])
-
-
- def setup(app):
- app.connect('builder-inited', builder_inited_handler)
|