|
- # Copyright (c) 2021 PaddlePaddle Authors. All Rights Reserved.
- #
- # Licensed under the Apache License, Version 2.0 (the "License");
- # you may not use this file except in compliance with the License.
- # You may obtain a copy of the License at
- #
- # http://www.apache.org/licenses/LICENSE-2.0
- #
- # Unless required by applicable law or agreed to in writing, software
- # distributed under the License is distributed on an "AS IS" BASIS,
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- # See the License for the specific language governing permissions and
- # limitations under the License.
-
- # 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
-
- sys.path.insert(0, os.path.abspath("../.."))
- sys.path.append(os.path.abspath(".."))
-
- # -- Project information -----------------------------------------------------
-
- project = "PaddleNLP"
- copyright = "2021, PaddleNLP"
- author = "PaddleNLP"
- default_role = "py:obj"
-
- # -- 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_rtd_theme",
- "recommonmark",
- "sphinx.ext.autodoc",
- "sphinx.ext.autosummary",
- "sphinx.ext.napoleon",
- "sphinx_copybutton",
- "sphinx_markdown_tables",
- "sphinx.ext.viewcode",
- "sphinx.ext.coverage",
- "sphinx.ext.extlinks",
- ]
-
- autodoc_default_options = {
- "member-order": "bysource",
- "undoc-members": False,
- }
-
- autosummary_generate = True
-
- # Add any paths that contain templates here, relative to this directory.
- templates_path = ["_templates"]
-
- # 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.
- locale_dirs = ["locale/"]
- gettext_compact = False
- language = "zh_CN"
- add_module_names = False
-
- # 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 = []
-
- # source_parsers = {
- # '.md': recommonmark.parser.CommonMarkParser,
- # }
- source_suffix = [".rst", ".md"]
-
- # -- 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_options = {
- "collapse_navigation": True,
- "display_version": True,
- "navigation_depth": 5,
- "navigation_with_keys": True,
- "body_max_width": "80%",
- }
-
- html_css_files = [
- "custom.css",
- ]
-
- # 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_logo = "paddle.png"
|