mirror of
https://github.com/PaddlePaddle/FastDeploy.git
synced 2025-10-05 16:48:03 +08:00
79 lines
2.8 KiB
Python
79 lines
2.8 KiB
Python
# 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('../python'))
|
|
from recommonmark.transform import AutoStructify
|
|
from recommonmark.parser import CommonMarkParser
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'FastDeploy Python API'
|
|
copyright = '2022, PaddlePaddle'
|
|
author = 'PaddlePaddle'
|
|
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = "latest"
|
|
# -- 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.napoleon',
|
|
'myst_parser',
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.mathjax',
|
|
'sphinx_markdown_tables',
|
|
'sphinx.ext.viewcode',
|
|
'sphinx.ext.githubpages',
|
|
]
|
|
|
|
autoclass_content = 'both'
|
|
package_dir = {"": ["python"]}
|
|
suppress_warnings = [ 'ref.myst']
|
|
# 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}
|
|
# two wr style: reStructuredText/MarkDown
|
|
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 = "en"
|
|
# 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 = 'furo'
|
|
html_theme = 'sphinx_book_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)
|