X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=test%2Fdoc%2Fconf.py;h=f5e974954d807af22521c0dc19f4d4f632d8ac3e;hb=61717cc38;hp=aa8417149df5036c79beb0e87e96f26e8c1412cc;hpb=f62ae1288a776527c7f7ba3951531fbd07bc63da;p=vpp.git diff --git a/test/doc/conf.py b/test/doc/conf.py index aa8417149df..f5e974954d8 100644 --- a/test/doc/conf.py +++ b/test/doc/conf.py @@ -18,7 +18,7 @@ # import os import sys -sys.path.insert(0, os.path.abspath('..')) +sys.path.insert(0, os.path.abspath('../../build-root/build-test/src')) # -- General configuration ------------------------------------------------ @@ -32,6 +32,14 @@ sys.path.insert(0, os.path.abspath('..')) extensions = [ 'sphinx.ext.autodoc', ] +autodoc_mock_imports = ['objgraph', + 'parameterized', + 'pexpect', + 'psutil', + 'pympler', + 'scapy', + 'syslog_rfc5424_parser', + 'vpp_papi'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -51,7 +59,7 @@ master_doc = 'index' # General information about the project. project = u'VPP test framework' -copyright = u'2016, VPP team' +copyright = u'2019, VPP team' author = u'VPP team' # The version info for the project you're documenting, acts as replacement for @@ -59,9 +67,9 @@ author = u'VPP team' # built documents. # # The short X.Y version. -version = u'0.1' +version = u'20.01' # The full version, including alpha/beta/rc tags. -release = u'0.1' +release = u'20.01-rc0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -87,11 +95,11 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The reST default role (used for this markup: `text`) to use for all # documents. # -# default_role = None +default_role = 'any' # If true, '()' will be appended to :func: etc. cross-reference text. # -# add_function_parentheses = True +add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). @@ -121,7 +129,8 @@ todo_include_todos = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +# html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -147,15 +156,15 @@ html_theme = 'alabaster' # html_logo = None # The name of an image file (relative to this directory) to use as a favicon of -# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. +# the docs. This file should be a Windows icon file (.ico) being 16x16 or +# 32x32 pixels large. # # html_favicon = None # 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_static_path = [] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied