diff options
author | Cédric Ollivier <cedric.ollivier@orange.com> | 2018-04-04 07:00:49 +0200 |
---|---|---|
committer | Cédric Ollivier <cedric.ollivier@orange.com> | 2018-04-04 07:00:49 +0200 |
commit | dc05660b89cb13d2abf2079f3a7e490a92154c14 (patch) | |
tree | f8452861640b4127f1372480a8ee1934aea08388 /api/conf.py | |
parent | 488e073a3d47fd75428c791561f3813a6192b167 (diff) |
Check API doc via doc8
It also cleans unseless dirs.
Change-Id: I52ddc9e2adcd13c95e4a8939397686f50b9e6c4c
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
Diffstat (limited to 'api/conf.py')
-rw-r--r-- | api/conf.py | 26 |
1 files changed, 18 insertions, 8 deletions
diff --git a/api/conf.py b/api/conf.py index e197623d..1f6645fd 100644 --- a/api/conf.py +++ b/api/conf.py @@ -82,7 +82,7 @@ language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = [] # The reST default role (used for this markup: `text`) to use for all # documents. @@ -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, 'Xtesting.tex', u'Xtesting Documentation', - u'\\#opnfv-functest (chat.freenode.net)', 'manual'), + (master_doc, + 'Xtesting.tex', + u'Xtesting 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,8 +306,11 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'xtesting', u'Xtesting Documentation', - [author], 1) + (master_doc, + 'xtesting', + u'Xtesting Documentation', + [author], + 1) ] # If true, show URL addresses after external links. @@ -318,8 +324,12 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'Xtesting', u'Xtesting Documentation', - author, 'Xtesting', 'One line description of project.', + (master_doc, + 'Xtesting', + u'Xtesting Documentation', + author, + 'Xtesting', + 'One line description of project.', 'Miscellaneous'), ] |