X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fconf.py;h=c368fa51d431e5b976fc5cf3add488d42b732fca;hb=affc17c821e37e53d786a1d0b7c179f533684ac1;hp=38de280eff21d3c99679c3014924433fb89aba93;hpb=48595b8d559e362f0732a6453993c7afc092948c;p=dpdk.git diff --git a/doc/guides/conf.py b/doc/guides/conf.py index 38de280eff..c368fa51d4 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -9,6 +9,7 @@ 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 @@ -37,7 +38,9 @@ html_add_permalinks = "" html_show_copyright = False highlight_language = 'none' -version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion']) +# If MAKEFLAGS is exported by the user, garbage text might end up in version +version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion'], + env=dict(environ, MAKEFLAGS="")) version = version.decode('utf-8').rstrip() release = version @@ -59,11 +62,11 @@ latex_documents = [ # 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. @@ -234,7 +237,7 @@ def generate_overview_table(output_filename, table_id, section, table_name, titl ini_filename)) continue - if value is not '': + if value: # Get the first letter only. ini_data[ini_filename][name] = value[0] @@ -388,6 +391,21 @@ def setup(app): '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__) + '/vdpadevs/overview_feature_table.txt' + generate_overview_table(table_file, 1, + 'Features', + 'Features availability in vDPA drivers', + 'Feature') if LooseVersion(sphinx_version) < LooseVersion('1.3.1'): print('Upgrade sphinx to version >= 1.3.1 for '