X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fconf.py;h=67d2dd62c7fcd2820562b55abe4534529f3c19f7;hb=5a36ec735130f81a187ef65c4bc43c445a89568d;hp=ef0e1c607a98d4385bf495f01339fe228eca9155;hpb=8bc74683de1c744aed19a5822a9f91dddcc7918b;p=dpdk.git diff --git a/doc/guides/conf.py b/doc/guides/conf.py index ef0e1c607a..67d2dd62c7 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -1,115 +1,51 @@ -# BSD LICENSE -# Copyright(c) 2010-2015 Intel Corporation. All rights reserved. -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions -# are met: -# -# * Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. -# * Redistributions in binary form must reproduce the above copyright -# notice, this list of conditions and the following disclaimer in -# the documentation and/or other materials provided with the -# distribution. -# * Neither the name of Intel Corporation nor the names of its -# contributors may be used to endorse or promote products derived -# from this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -from __future__ import print_function -import subprocess +#!/usr/bin/env python3 +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2010-2015 Intel Corporation + from docutils import nodes from distutils.version import LooseVersion from sphinx import __version__ as sphinx_version -from sphinx.highlighting import PygmentsBridge -from pygments.formatters.latex import LatexFormatter from os import listdir +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 try: - # Python 2. - import ConfigParser as configparser + import sphinx_rtd_theme + + html_theme = "sphinx_rtd_theme" except: - # Python 3. - import configparser + print('Install the sphinx ReadTheDocs theme for improved html documentation ' + 'layout: https://sphinx-rtd-theme.readthedocs.io/', + file=stderr) + pass +stop_on_error = ('-W' in argv) project = 'Data Plane Development Kit' - -if LooseVersion(sphinx_version) >= LooseVersion('1.3.1'): - html_theme = "sphinx_rtd_theme" html_logo = '../logo/DPDK_logo_vertical_rev_small.png' -latex_logo = '../logo/DPDK_logo_horizontal_tag.png' -html_add_permalinks = "" +if LooseVersion(sphinx_version) >= LooseVersion('3.5'): + html_permalinks = False +else: + html_add_permalinks = "" html_show_copyright = False highlight_language = 'none' -version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion']) -version = version.decode('utf-8').rstrip() -release = version +release = environ.setdefault('DPDK_VERSION', "None") +version = release master_doc = 'index' # Maximum feature description string length -feature_str_len = 25 +feature_str_len = 30 # Figures, tables and code-blocks automatically numbered if they have caption numfig = True -latex_documents = [ - ('index', - 'doc.tex', - '', - '', - 'manual') -] - -# Latex directives to be included directly in the latex/pdf docs. -custom_latex_preamble = r""" -\usepackage[utf8]{inputenc} -\usepackage[T1]{fontenc} -\usepackage{helvet} -\renewcommand{\familydefault}{\sfdefault} -\RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm} -""" - -# Configuration for the latex/pdf docs. -latex_elements = { - 'papersize': 'a4paper', - 'pointsize': '11pt', - # remove blank pages - 'classoptions': ',openany,oneside', - 'babel': '\\usepackage[english]{babel}', - # customize Latex formatting - 'preamble': custom_latex_preamble -} - - -# Override the default Latex formatter in order to modify the -# code/verbatim blocks. -class CustomLatexFormatter(LatexFormatter): - def __init__(self, **options): - super(CustomLatexFormatter, self).__init__(**options) - # Use the second smallest font size for code/verbatim blocks. - self.verboptions = r'formatcom=\footnotesize' - -# Replace the default latex formatter. -PygmentsBridge.latex_formatter = CustomLatexFormatter - # Configuration for man pages man_pages = [("testpmd_app_ug/run_app", "testpmd", "tests for dpdk pmds", "", 1), @@ -178,7 +114,7 @@ def process_numref(app, doctree, from_docname): node.replace_self(newnode) -def generate_overview_table(output_filename, section, table_name, title): +def generate_overview_table(output_filename, table_id, section, table_name, title): """ Function to generate the Overview Table from the ini files that define the features for each driver. @@ -211,18 +147,23 @@ def generate_overview_table(output_filename, section, table_name, title): ini_files.sort() # Build up a list of the table header names from the ini filenames. - header_names = [] + pmd_names = [] for ini_filename in ini_files: name = ini_filename[:-4] name = name.replace('_vf', 'vf') + pmd_names.append(name) - # Pad the table header names to match the existing format. + # Pad the table header names. + max_header_len = len(max(pmd_names, key=len)) + header_names = [] + for name in pmd_names: if '_vec' in name: pmd, vec = name.split('_') - name = '{0:{fill}{align}7}vec'.format(pmd, fill='.', align='<') + name = '{0:{fill}{align}{width}}vec'.format(pmd, + fill='.', align='<', width=max_header_len-3) else: - name = '{0:{fill}{align}10}'.format(name, fill=' ', align='<') - + name = '{0:{fill}{align}{width}}'.format(name, + fill=' ', align='<', width=max_header_len) header_names.append(name) # Create a dict of the defined features for each driver from the ini files. @@ -235,11 +176,8 @@ def generate_overview_table(output_filename, section, table_name, title): # Initialize the dict with the default.ini value. ini_data[ini_filename] = valid_features.copy() - # Check for a valid ini section. + # Check for a section. if not config.has_section(section): - print("{}: File '{}' has no [{}] secton".format(warning, - ini_filename, - section)) continue # Check for valid features names. @@ -247,10 +185,13 @@ def generate_overview_table(output_filename, section, table_name, title): 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 is not '': + if value: # Get the first letter only. ini_data[ini_filename][name] = value[0] @@ -258,9 +199,8 @@ def generate_overview_table(output_filename, section, table_name, title): outfile = open(output_filename, 'w') num_cols = len(header_names) - print('.. table:: ' + table_name + '\n', - file=outfile) - + print_table_css(outfile, table_id) + print('.. table:: ' + table_name + '\n', file=outfile) print_table_header(outfile, num_cols, header_names, title) print_table_body(outfile, num_cols, ini_files, ini_data, default_features) @@ -275,7 +215,7 @@ def print_table_header(outfile, num_cols, header_names, title): print_table_row(outfile, title, line) - for i in range(1, 10): + for i in range(1, len(header_names[0])): line = '' for name in header_names: line += ' ' + name[i] @@ -316,37 +256,150 @@ def print_table_divider(outfile, num_cols): print_table_row(outfile, feature, line) +def print_table_css(outfile, table_id): + template = """ +.. raw:: html + + +""" + print(template.replace("idx", "id%d" % (table_id)), file=outfile) + + def setup(app): table_file = dirname(__file__) + '/nics/overview_table.txt' - generate_overview_table(table_file, + generate_overview_table(table_file, 1, 'Features', 'Features availability in networking drivers', 'Feature') + table_file = dirname(__file__) + '/nics/rte_flow_items_table.txt' + generate_overview_table(table_file, 2, + 'rte_flow items', + 'rte_flow items availability in networking drivers', + 'Item') + table_file = dirname(__file__) + '/nics/rte_flow_actions_table.txt' + generate_overview_table(table_file, 3, + 'rte_flow actions', + 'rte_flow actions availability in networking drivers', + 'Action') table_file = dirname(__file__) + '/cryptodevs/overview_feature_table.txt' - generate_overview_table(table_file, + generate_overview_table(table_file, 1, 'Features', 'Features availability in crypto drivers', 'Feature') table_file = dirname(__file__) + '/cryptodevs/overview_cipher_table.txt' - generate_overview_table(table_file, + generate_overview_table(table_file, 2, 'Cipher', 'Cipher algorithms in crypto drivers', 'Cipher algorithm') table_file = dirname(__file__) + '/cryptodevs/overview_auth_table.txt' - generate_overview_table(table_file, + generate_overview_table(table_file, 3, 'Auth', 'Authentication algorithms in crypto drivers', 'Authentication algorithm') table_file = dirname(__file__) + '/cryptodevs/overview_aead_table.txt' - generate_overview_table(table_file, + generate_overview_table(table_file, 4, 'AEAD', 'AEAD algorithms in crypto drivers', 'AEAD algorithm') + table_file = dirname(__file__) + '/cryptodevs/overview_asym_table.txt' + generate_overview_table(table_file, 5, + 'Asymmetric', + 'Asymmetric algorithms in crypto drivers', + 'Asymmetric algorithm') + table_file = dirname(__file__) + '/compressdevs/overview_feature_table.txt' + generate_overview_table(table_file, 1, + 'Features', + 'Features availability in compression drivers', + 'Feature') + table_file = dirname(__file__) + '/regexdevs/overview_feature_table.txt' + generate_overview_table(table_file, 1, + 'Features', + 'Features availability in regex drivers', + 'Feature') + table_file = dirname(__file__) + '/vdpadevs/overview_feature_table.txt' + generate_overview_table(table_file, 1, + 'Features', + 'Features availability in vDPA drivers', + 'Feature') + table_file = dirname(__file__) + '/bbdevs/overview_feature_table.txt' + generate_overview_table(table_file, 1, + 'Features', + 'Features availability in bbdev drivers', + 'Feature') 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. app.connect('doctree-resolved', process_numref) + + try: + # New function in sphinx 1.8 + app.add_css_file('css/custom.css') + except: + app.add_stylesheet('css/custom.css')