X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fconf.py;h=aceeb62a4f627118e2390dc24dbfbf048bc13da2;hb=ff70acdf4299e5e8156e0fb12dddfe02bafb5741;hp=270754b901315166c641bf0bfe4355776ff0c1b8;hpb=b1df4163a86b91ba66f8f6dd5a76859349967c5f;p=dpdk.git diff --git a/doc/guides/conf.py b/doc/guides/conf.py index 270754b901..aceeb62a4f 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -12,6 +12,7 @@ from os import environ from os.path import basename from os.path import dirname from os.path import join as path_join +from sys import argv, stderr import configparser @@ -22,9 +23,12 @@ try: html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] except: print('Install the sphinx ReadTheDocs theme for improved html documentation ' - 'layout: https://sphinx-rtd-theme.readthedocs.io/') + 'layout: https://sphinx-rtd-theme.readthedocs.io/', + file=stderr) pass +stop_on_error = ('-W' in argv) + project = 'Data Plane Development Kit' html_logo = '../logo/DPDK_logo_vertical_rev_small.png' latex_logo = '../logo/DPDK_logo_horizontal_tag.png' @@ -32,7 +36,8 @@ html_add_permalinks = "" html_show_copyright = False highlight_language = 'none' -release = environ['DPDK_VERSION'] +release = environ.setdefault('DPDK_VERSION', "None") +version = release master_doc = 'index' @@ -216,7 +221,10 @@ def generate_overview_table(output_filename, table_id, section, table_name, titl if not config.has_section(section): print("{}: File '{}' has no [{}] secton".format(warning, ini_filename, - section)) + section), + file=stderr) + if stop_on_error: + raise Exception('Warning is treated as a failure') continue # Check for valid features names. @@ -224,7 +232,10 @@ def generate_overview_table(output_filename, table_id, section, table_name, titl if name not in valid_features: print("{}: Unknown feature '{}' in '{}'".format(warning, name, - ini_filename)) + ini_filename), + file=stderr) + if stop_on_error: + raise Exception('Warning is treated as a failure') continue if value: @@ -417,7 +428,8 @@ def setup(app): if LooseVersion(sphinx_version) < LooseVersion('1.3.1'): print('Upgrade sphinx to version >= 1.3.1 for ' - 'improved Figure/Table number handling.') + 'improved Figure/Table number handling.', + file=stderr) # Add a role to handle :numref: references. app.add_role('numref', numref_role) # Process the numref references once the doctree has been created.