diff options
author | Cédric Ollivier <cedric.ollivier@orange.com> | 2018-04-04 06:50:19 +0200 |
---|---|---|
committer | Cédric Ollivier <cedric.ollivier@orange.com> | 2018-04-04 15:59:24 +0200 |
commit | 4fdae297551f0d1be07cf2edd39e3428923b52ae (patch) | |
tree | 447c2d453888487171c062ccbfc98c2593b8d101 /api/conf.py | |
parent | 2b63550f650c2ae412b5515cd596f38261619d27 (diff) |
Check API doc via doc8
It also cleans unseless dirs.
Change-Id: I13be1359b36c49e8f199087fe2a23818c6d1b6e0
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
Diffstat (limited to 'api/conf.py')
-rw-r--r-- | api/conf.py | 21 |
1 files changed, 15 insertions, 6 deletions
diff --git a/api/conf.py b/api/conf.py index b5adb4ca3..e9978f6ad 100644 --- a/api/conf.py +++ b/api/conf.py @@ -155,7 +155,7 @@ html_theme = 'sphinx_rtd_theme' # 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 @@ -261,8 +261,11 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'OPNFVFunctest.tex', u'OPNFV Functest Documentation', - u'\\#opnfv-functest (chat.freenode.net)', 'manual'), + (master_doc, + 'OPNFVFunctest.tex', + u'OPNFV Functest Documentation', + u'\\#opnfv-functest (chat.freenode.net)', + 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -303,7 +306,9 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'opnfvfunctest', u'OPNFV Functest Documentation', + (master_doc, + 'opnfvfunctest', + u'OPNFV Functest Documentation', [author], 1) ] @@ -318,8 +323,12 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'OPNFVFunctest', u'OPNFV Functest Documentation', - author, 'OPNFVFunctest', 'One line description of project.', + (master_doc, + 'OPNFVFunctest', + u'OPNFV Functest Documentation', + author, + 'OPNFVFunctest', + 'One line description of project.', 'Miscellaneous'), ] |