|
- # Copyright (c) 2019 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:
- # 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.
- #
- # import os
- # import sys
- # sys.path.insert(0, os.path.abspath('.'))
-
- # -- Project information -----------------------------------------------------
-
- import sphinx_rtd_theme
- import os
- import sys
- import parl
- release = parl.__version__
- project = 'PARL'
- copyright = '2019, nlp-ol@baidu.com'
- author = 'nlp-ol@baidu.com'
-
- # The full version, including alpha/beta/rc tags
- autodoc_mock_imports = ['paddle']
-
- # -- 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.viewcode',
- 'sphinx.ext.autodoc',
- 'sphinx.ext.todo',
- 'sphinx.ext.napoleon',
- 'sphinx.ext.mathjax',
- 'sphinx.ext.intersphinx',
- ]
-
- # 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.
- 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 = 'sphinx_rtd_theme'
- html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
- # 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 = './images/PARL-logo-2.png'
-
- master_doc = 'index'
- napoleon_use_ivar = True
-
-
- # do not skip documentation of the __init__ function of a class
- def skip(app, what, name, obj, would_skip, options):
- if name == "__init__":
- return False
- return would_skip
-
-
- def setup(app):
- app.connect("autodoc-skip-member", skip)
-
-
- add_module_names = False
-
- latex_engine = 'xelatex'
- latex_use_xindy = False
- latex_elements = {
- 'preamble': '\\usepackage[UTF8]{ctex}\n',
- }
-
- latex_elements = {
- # The paper size ('letterpaper' or 'a4paper').
- #'papersize': 'letterpaper',
-
- # The font size ('10pt', '11pt' or '12pt').
- #'pointsize': '10pt',
-
- # Additional stuff for the LaTeX preamble.
- #'preamble': '',
- 'preamble':
- r'''
- \hypersetup{unicode=true}
- \usepackage{CJKutf8}
- \DeclareUnicodeCharacter{00A0}{\nobreakspace}
- \DeclareUnicodeCharacter{2203}{\ensuremath{\exists}}
- \DeclareUnicodeCharacter{2200}{\ensuremath{\forall}}
- \DeclareUnicodeCharacter{2286}{\ensuremath{\subseteq}}
- \DeclareUnicodeCharacter{2713}{x}
- \DeclareUnicodeCharacter{27FA}{\ensuremath{\Longleftrightarrow}}
- \DeclareUnicodeCharacter{221A}{\ensuremath{\sqrt{}}}
- \DeclareUnicodeCharacter{221B}{\ensuremath{\sqrt[3]{}}}
- \DeclareUnicodeCharacter{2295}{\ensuremath{\oplus}}
- \DeclareUnicodeCharacter{2297}{\ensuremath{\otimes}}
- \begin{CJK}{UTF8}{gbsn}
- \AtEndDocument{\end{CJK}}
- ''',
- }
|