# 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: # 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. # from recommonmark.transform import AutoStructify from recommonmark.parser import CommonMarkParser import os import sys sys.path.insert(0, os.path.abspath('../paddlehub')) # -- Project information ----------------------------------------------------- project = 'PaddleHub' copyright = '2020, PaddlePaddle' author = 'PaddlePaddle' # The full version, including alpha/beta/rc tags release = "v1.5" # -- 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.mathjax', 'sphinx_markdown_tables', 'sphinx.ext.napoleon', ] # 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_parsers = {'.md': CommonMarkParser} source_suffix = ['.rst', '.md'] # 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 = "Simplified Chinese" # 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 = [] # -- 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' # -- Extension configuration ------------------------------------------------- def setup(app): app.add_config_value('recommonmark_config', { 'enable_eval_rst': True, 'enable_auto_toc_tree': False, }, True) app.add_transform(AutoStructify)