|
- #
- # Configuration file for the Sphinx documentation builder.
- #
- # This file does only contain a selection of the most common options. For a
- # full list see the documentation:
- # http://www.sphinx-doc.org/en/master/config
-
- # -- 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
-
- from m2r import MdInclude
- from recommonmark.transform import AutoStructify
-
- sys.path.insert(0, os.path.abspath('..'))
-
- version_file = '../mmcv/version.py'
- with open(version_file, 'r') as f:
- exec(compile(f.read(), version_file, 'exec'))
- __version__ = locals()['__version__']
-
- # -- Project information -----------------------------------------------------
-
- project = 'mmcv'
- copyright = '2018-2019, Kai Chen'
- author = 'Kai Chen'
-
- # The short X.Y version
- version = __version__
- # The full version, including alpha/beta/rc tags
- release = __version__
-
- # -- General configuration ---------------------------------------------------
-
- # If your documentation needs a minimal Sphinx version, state it here.
- #
- # needs_sphinx = '1.0'
-
- # 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.ext.autosectionlabel',
- ]
-
- autodoc_mock_imports = [
- 'cv2', 'mmcv._ext', 'mmcv._flow_warp_ext', 'mmcv.utils.ext_loader',
- 'torchvision'
- ]
- autosectionlabel_prefix_document = True
-
- # 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'
-
- # 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 = None
-
- # 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']
-
- # The name of the Pygments (syntax highlighting) style to use.
- pygments_style = 'sphinx'
-
- # -- 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'
-
- # Theme options are theme-specific and customize the look and feel of a theme
- # further. For a list of options available for each theme, see the
- # documentation.
- #
- # html_theme_options = {}
-
- # 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']
-
- # Custom sidebar templates, must be a dictionary that maps document names
- # to template names.
- #
- # The default sidebars (for documents that don't match any pattern) are
- # defined by theme itself. Builtin themes are using these templates by
- # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
- # 'searchbox.html']``.
- #
- # html_sidebars = {}
-
- # -- Options for HTMLHelp output ---------------------------------------------
-
- # Output file base name for HTML help builder.
- htmlhelp_basename = 'mmcvdoc'
-
- # -- 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, 'mmcv.tex', 'mmcv Documentation', 'Kai Chen', '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, 'mmcv', 'mmcv Documentation', [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, 'mmcv', 'mmcv Documentation', author, 'mmcv',
- 'One line description of project.', 'Miscellaneous'),
- ]
-
- # -- Options for Epub output -------------------------------------------------
-
- # Bibliographic Dublin Core info.
- epub_title = project
-
- # The unique identifier of the text. This can be a ISBN number
- # or the project homepage.
- #
- # epub_identifier = ''
-
- # A unique identification for the text.
- #
- # epub_uid = ''
-
- # A list of files that should not be packed into the epub file.
- epub_exclude_files = ['search.html']
-
- # -- Extension configuration -------------------------------------------------
-
-
- def setup(app):
- app.add_config_value('no_underscore_emphasis', False, 'env')
- app.add_config_value('m2r_parse_relative_links', False, 'env')
- app.add_config_value('m2r_anonymous_references', False, 'env')
- app.add_config_value('m2r_disable_inline_math', False, 'env')
- app.add_directive('mdinclude', MdInclude)
- app.add_config_value('recommonmark_config', {
- 'auto_toc_tree_section': 'Contents',
- 'enable_eval_rst': True,
- }, True)
- app.add_transform(AutoStructify)
|