|
|
@@ -10,39 +10,44 @@
|
|
|
# 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('.'))
|
|
|
+import os
|
|
|
+import recommonmark
|
|
|
|
|
|
-import sphinx_rtd_theme
|
|
|
-html_theme = "sphinx_rtd_theme"
|
|
|
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
|
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
|
|
project = 'PaddleX'
|
|
|
-copyright = '2020, paddlex@baidu.com'
|
|
|
-author = 'paddlex@baidu.com'
|
|
|
-
|
|
|
-# The full version, including alpha/beta/rc tags
|
|
|
-release = '0.1.0'
|
|
|
-
|
|
|
-from recommonmark.parser import CommonMarkParser
|
|
|
-source_parsers = {
|
|
|
- '.md': CommonMarkParser,
|
|
|
-}
|
|
|
-source_suffix = ['.rst', '.md']
|
|
|
+copyright = '2020, paddlepaddle'
|
|
|
+author = 'paddlepaddle'
|
|
|
|
|
|
# -- 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_markdown_tables']
|
|
|
+
|
|
|
+extensions = [
|
|
|
+ 'sphinx.ext.autodoc',
|
|
|
+ 'sphinx.ext.napoleon',
|
|
|
+ 'sphinx.ext.coverage',
|
|
|
+ 'sphinx.ext.viewcode',
|
|
|
+ 'sphinx.ext.mathjax',
|
|
|
+ 'sphinx.ext.githubpages',
|
|
|
+ 'sphinx.ext.napoleon',
|
|
|
+ 'recommonmark',
|
|
|
+ 'sphinx_markdown_tables',
|
|
|
+]
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
|
templates_path = ['_templates']
|
|
|
|
|
|
+# md file can also be parased
|
|
|
+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.
|
|
|
#
|
|
|
@@ -50,20 +55,26 @@ templates_path = ['_templates']
|
|
|
# Usually you set "language" from the command line for these cases.
|
|
|
language = 'zh_CN'
|
|
|
|
|
|
-# 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', 'Thumbs.db', '.DS_Store']
|
|
|
-
|
|
|
# -- 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 = 'alabaster'
|
|
|
+
|
|
|
+# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
|
|
|
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
|
|
+
|
|
|
+if not on_rtd: # only import and set the theme if we're building docs locally
|
|
|
+ import sphinx_rtd_theme
|
|
|
+ html_theme = 'sphinx_rtd_theme'
|
|
|
+ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
|
+
|
|
|
+# otherwise, readthedocs.org uses their theme by default, so no need to specify it
|
|
|
|
|
|
# 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/paddlex.png'
|
|
|
+
|
|
|
+html_logo = '../images/logo.png'
|
|
|
+
|