OpenMMLab Detection Toolbox and Benchmark
https://mmdetection.readthedocs.io/
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
178 lines
5.4 KiB
178 lines
5.4 KiB
# 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 |
|
|
|
import pytorch_sphinx_theme |
|
|
|
sys.path.insert(0, os.path.abspath('..')) |
|
|
|
# -- Project information ----------------------------------------------------- |
|
|
|
project = 'MMDetection' |
|
copyright = '2018-2021, 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', |
|
'sphinx_copybutton', |
|
] |
|
|
|
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' |
|
html_theme = 'pytorch_sphinx_theme' |
|
html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()] |
|
|
|
html_theme_options = { |
|
'menu': [ |
|
{ |
|
'name': 'GitHub', |
|
'url': 'https://github.com/open-mmlab/mmdetection' |
|
}, |
|
{ |
|
'name': |
|
'Projects', |
|
'children': [ |
|
{ |
|
'name': 'MMAction2', |
|
'url': 'https://github.com/open-mmlab/mmaction2', |
|
}, |
|
{ |
|
'name': 'MMClassification', |
|
'url': 'https://github.com/open-mmlab/mmclassification', |
|
}, |
|
{ |
|
'name': 'MMDetection', |
|
'url': 'https://github.com/open-mmlab/mmdetection', |
|
}, |
|
{ |
|
'name': 'MMDetection3D', |
|
'url': 'https://github.com/open-mmlab/mmdetection3d', |
|
}, |
|
{ |
|
'name': 'MMEditing', |
|
'url': 'https://github.com/open-mmlab/mmediting', |
|
}, |
|
{ |
|
'name': 'MMGeneration', |
|
'url': 'https://github.com/open-mmlab/mmgeneration', |
|
}, |
|
{ |
|
'name': 'MMOCR', |
|
'url': 'https://github.com/open-mmlab/mmocr', |
|
}, |
|
{ |
|
'name': 'MMPose', |
|
'url': 'https://github.com/open-mmlab/mmpose', |
|
}, |
|
{ |
|
'name': 'MMSegmentation', |
|
'url': 'https://github.com/open-mmlab/mmsegmentation', |
|
}, |
|
{ |
|
'name': 'MMTracking', |
|
'url': 'https://github.com/open-mmlab/mmtracking', |
|
}, |
|
] |
|
}, |
|
{ |
|
'name': |
|
'OpenMMLab', |
|
'children': [ |
|
{ |
|
'name': 'Homepage', |
|
'url': 'https://openmmlab.com/' |
|
}, |
|
{ |
|
'name': 'GitHub', |
|
'url': 'https://github.com/open-mmlab/' |
|
}, |
|
{ |
|
'name': 'Twitter', |
|
'url': 'https://twitter.com/OpenMMLab' |
|
}, |
|
{ |
|
'name': 'Zhihu', |
|
'url': 'https://zhihu.com/people/openmmlab' |
|
}, |
|
] |
|
}, |
|
] |
|
} |
|
|
|
# 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'] |
|
html_css_files = ['css/readthedocs.css'] |
|
|
|
# -- Extension configuration ------------------------------------------------- |
|
# Ignore >>> when copying code |
|
copybutton_prompt_text = r'>>> |\.\.\. ' |
|
copybutton_prompt_is_regexp = True |
|
|
|
|
|
def builder_inited_handler(app): |
|
subprocess.run(['./stat.py']) |
|
|
|
|
|
def setup(app): |
|
app.connect('builder-inited', builder_inited_handler)
|
|
|