-
Notifications
You must be signed in to change notification settings - Fork 114
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Docs] Refactor the structure of documentation and update pre-commit (#…
…27) * [Docs] update batch size * [Docs] pre-commit and docs * Update .pre-commit-config.yaml Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com> Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
- Loading branch information
Showing
63 changed files
with
258 additions
and
378 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
# 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 pytorch_sphinx_theme | ||
|
||
sys.path.insert(0, os.path.abspath('../..')) | ||
|
||
# -- Project information ----------------------------------------------------- | ||
|
||
project = 'mmfewshot' | ||
copyright = '2018-2021, OpenMMLab' | ||
author = 'MMFewShot Author' | ||
version_file = '../../mmfewshot/version.py' | ||
|
||
|
||
def get_version(): | ||
with open(version_file, 'r') as f: | ||
exec(compile(f.read(), version_file, 'exec')) | ||
return locals()['__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.ext.autosectionlabel', | ||
'sphinx_copybutton', | ||
'sphinx_markdown_tables', | ||
] | ||
|
||
autodoc_mock_imports = ['matplotlib', 'mmfewshot.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 = 'pytorch_sphinx_theme' | ||
html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()] | ||
# 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 = { | ||
'menu': [ | ||
{ | ||
'name': 'GitHub', | ||
'url': 'https://github.com/open-mmlab/mmfewshot' | ||
}, | ||
{ | ||
'name': | ||
'Upstream', | ||
'children': [ | ||
{ | ||
'name': 'MMCV', | ||
'url': 'https://github.com/open-mmlab/mmcv', | ||
'description': 'Foundational library for computer vision' | ||
}, | ||
{ | ||
'name': 'MMClassification', | ||
'url': | ||
'https://mmclassification.readthedocs.io/en/latest/', | ||
'description': 'Image classification toolbox and benchmark' | ||
}, | ||
{ | ||
'name': 'MMDetection', | ||
'url': 'https://github.com/open-mmlab/mmdetection', | ||
'description': 'Object detection toolbox and benchmark' | ||
}, | ||
] | ||
}, | ||
], | ||
# Specify the language of shared menu | ||
'menu_lang': | ||
'en' | ||
} | ||
|
||
# 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 |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.