+#!/usr/bin/env python3
# SPDX-License-Identifier: BSD-3-Clause
# Copyright(c) 2010-2015 Intel Corporation
-from __future__ import print_function
-import subprocess
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
-try:
- # Python 2.
- import ConfigParser as configparser
-except:
- # Python 3.
- import configparser
+import configparser
try:
import sphinx_rtd_theme
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
except:
print('Install the sphinx ReadTheDocs theme for improved html documentation '
- 'layout: pip install sphinx_rtd_theme')
+ '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'
html_show_copyright = False
highlight_language = 'none'
-version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion'])
-version = version.decode('utf-8').rstrip()
-release = version
+release = environ['DPDK_VERSION']
+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 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}
+\usepackage{textalpha}
\RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm}
+\usepackage{etoolbox}
+\robustify\(
+\robustify\)
"""
# Configuration for the latex/pdf docs.
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.
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.
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]
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]
cursor: default;
overflow: hidden;
}
+ table#idx p {
+ margin: 0;
+ line-height: inherit;
+ }
table#idx th, table#idx td {
text-align: center;
+ border: solid 1px #ddd;
}
table#idx th {
- font-size: 80%;
+ padding: 0.5em 0;
+ }
+ table#idx th, table#idx th p {
+ font-size: 11px;
white-space: pre-wrap;
vertical-align: top;
- padding: 0.5em 0;
min-width: 0.9em;
- width: 2em;
}
table#idx col:first-child {
width: 0;
vertical-align: bottom;
}
table#idx td {
- font-size: 70%;
padding: 1px;
}
+ table#idx td, table#idx td p {
+ font-size: 11px;
+ }
table#idx td:first-child {
padding-left: 1em;
text-align: left;
'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)
- app.add_stylesheet('css/custom.css')
+ try:
+ # New function in sphinx 1.8
+ app.add_css_file('css/custom.css')
+ except:
+ app.add_stylesheet('css/custom.css')
git.droids-corp.org / dpdk.git / blobdiff