X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fconf.py;h=34c62de679453d8be40675097f6f36208f9416b4;hb=39922c470e3ce7dcb00910e8f821b7fdd718c3b5;hp=cd6a4f7696281e429e8819045eff8fe712fecd39;hpb=9db3f52126fbd759653b4092bce199dd040c1a8b;p=dpdk.git diff --git a/doc/guides/conf.py b/doc/guides/conf.py index cd6a4f7696..34c62de679 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -58,7 +58,8 @@ html_add_permalinks = "" html_show_copyright = False highlight_language = 'none' -version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion']).decode('utf-8').rstrip() +version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion']) +version = version.decode('utf-8').rstrip() release = version master_doc = 'index' @@ -94,6 +95,7 @@ latex_elements = { 'preamble': latex_preamble } + # Override the default Latex formatter in order to modify the # code/verbatim blocks. class CustomLatexFormatter(LatexFormatter): @@ -105,12 +107,24 @@ class CustomLatexFormatter(LatexFormatter): # Replace the default latex formatter. PygmentsBridge.latex_formatter = CustomLatexFormatter -######## :numref: fallback ######## +# Configuration for man pages +man_pages = [("testpmd_app_ug/run_app", "testpmd", + "tests for dpdk pmds", "", 1), + ("tools/pdump", "dpdk-pdump", + "enable packet capture on dpdk ports", "", 1), + ("tools/proc_info", "dpdk-procinfo", + "access dpdk port stats and memory info", "", 1), + ("tools/pmdinfo", "dpdk-pmdinfo", + "dump a PMDs hardware support info", "", 1), + ("tools/devbind", "dpdk-devbind", + "check device status and bind/unbind them from drivers", "", 8)] + + +# ####### :numref: fallback ######## # The following hook functions add some simple handling for the :numref: # directive for Sphinx versions prior to 1.3.1. The functions replace the # :numref: reference with a link to the target (for all Sphinx doc types). # It doesn't try to label figures/tables. - def numref_role(reftype, rawtext, text, lineno, inliner): """ Add a Sphinx role to handle numref references. Note, we can't convert @@ -124,6 +138,7 @@ def numref_role(reftype, rawtext, text, lineno, inliner): internal=True) return [newnode], [] + def process_numref(app, doctree, from_docname): """ Process the numref nodes once the doctree has been built and prior to @@ -300,7 +315,8 @@ def print_table_divider(outfile, num_cols): def setup(app): - generate_nic_overview_table('doc/guides/nics/overview_table.txt') + table_file = dirname(__file__) + '/nics/overview_table.txt' + generate_nic_overview_table(table_file) if LooseVersion(sphinx_version) < LooseVersion('1.3.1'): print('Upgrade sphinx to version >= 1.3.1 for '