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.
PaddleSpeech/docs/source/conf.py

94 lines
3.2 KiB

3 years ago
# Copyright (c) 2020 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
3 years ago
import recommonmark.parser
import sphinx_rtd_theme
sys.path.insert(0, os.path.abspath('../..'))
sys.path.insert(0, os.path.abspath('../../audio'))
3 years ago
3 years ago
autodoc_mock_imports = ["soundfile", "librosa"]
3 years ago
# -- Project information -----------------------------------------------------
project = 'paddle speech'
copyright = '2021, paddlespeech-developers'
author = 'paddlespeech-developers'
3 years ago
# The full version, including alpha/beta/rc tags
release = '2.1'
# -- General configuration ---------------------------------------------------
source_parsers = {
'.md': recommonmark.parser.CommonMarkParser,
}
source_suffix = ['.rst', '.md']
master_doc = 'index'
pygments_style = 'sphinx'
# 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.viewcode',
3 years ago
"sphinx_rtd_theme",
3 years ago
'sphinx.ext.mathjax',
'numpydoc',
3 years ago
'sphinx.ext.autosummary',
3 years ago
'myst_parser',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# 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',
]
# -- 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_path = [sphinx_rtd_theme.get_html_theme_path()]
smartquotes = False
# 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']
3 years ago
html_logo = '../images/paddle.png'
3 years ago
html_css_files = [
'custom.css',
]
3 years ago
# -- Extension configuration -------------------------------------------------
# numpydoc_show_class_members = False