X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fconf.py;h=270754b901315166c641bf0bfe4355776ff0c1b8;hb=01863b9d2354;hp=c368fa51d431e5b976fc5cf3add488d42b732fca;hpb=6222035e1af43c1c1d588eb0cc5004d62591e1b4;p=dpdk.git diff --git a/doc/guides/conf.py b/doc/guides/conf.py index c368fa51d4..270754b901 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -1,8 +1,7 @@ +#!/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 @@ -14,12 +13,7 @@ from os.path import basename from os.path import dirname from os.path import join as path_join -try: - # Python 2. - import ConfigParser as configparser -except: - # Python 3. - import configparser +import configparser try: import sphinx_rtd_theme @@ -28,7 +22,7 @@ try: 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/') pass project = 'Data Plane Development Kit' @@ -38,16 +32,12 @@ html_add_permalinks = "" html_show_copyright = False highlight_language = 'none' -# 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 +release = environ['DPDK_VERSION'] 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 @@ -314,16 +304,22 @@ def print_table_css(outfile, table_id): 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: 72%; + 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; @@ -332,9 +328,11 @@ def print_table_css(outfile, table_id): 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; @@ -401,11 +399,21 @@ def setup(app): '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 ' @@ -415,4 +423,8 @@ def setup(app): # 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')