X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fconf.py;h=b2290b4474fe85c9489983cce5af78a49ad70c30;hb=90f6499cb2c6e94116f4c37a0994ac3490e369eb;hp=264b0cde80ddefd73e52b3cba7728ab278321347;hpb=ebf8050afd446f3ea249fe55aac756b09757ff8e;p=dpdk.git

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 264b0cde80..b2290b4474 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -29,16 +29,25 @@
 #   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 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
 
 project = 'DPDK'
 
 html_show_copyright = False
+highlight_language = 'none'
 
-version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion'])
+version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion']).decode('utf-8')
 release = version
 
 master_doc = 'index'
 
+# Figures, tables and code-blocks automatically numbered if they have caption
+numfig = True
+
 latex_documents = [
     ('index',
      'doc.tex',
@@ -46,3 +55,98 @@ latex_documents = [
      '',
      'manual')
 ]
+
+# Latex directives to be included directly in the latex/pdf docs.
+latex_preamble = r"""
+\usepackage[utf8]{inputenc}
+\usepackage{DejaVuSansMono}
+\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': 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
+
+######## :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
+    the link here because the doctree isn't build and the target information
+    isn't available.
+    """
+    # Add an identifier to distinguish numref from other references.
+    newnode = nodes.reference('',
+                              '',
+                              refuri='_local_numref_#%s' % text,
+                              internal=True)
+    return [newnode], []
+
+def process_numref(app, doctree, from_docname):
+    """
+    Process the numref nodes once the doctree has been built and prior to
+    writing the files. The processing involves replacing the numref with a
+    link plus text to indicate if it is a Figure or Table link.
+    """
+
+    # Iterate over the reference nodes in the doctree.
+    for node in doctree.traverse(nodes.reference):
+        target = node.get('refuri', '')
+
+        # Look for numref nodes.
+        if target.startswith('_local_numref_#'):
+            target = target.replace('_local_numref_#', '')
+
+            # Get the target label and link information from the Sphinx env.
+            data = app.builder.env.domains['std'].data
+            docname, label, _ = data['labels'].get(target, ('', '', ''))
+            relative_url = app.builder.get_relative_uri(from_docname, docname)
+
+            # Add a text label to the link.
+            if target.startswith('figure'):
+                caption = 'Figure'
+            elif target.startswith('table'):
+                caption = 'Table'
+            else:
+                caption = 'Link'
+
+            # New reference node with the updated link information.
+            newnode = nodes.reference('',
+                                      caption,
+                                      refuri='%s#%s' % (relative_url, label),
+                                      internal=True)
+            node.replace_self(newnode)
+
+def setup(app):
+    if LooseVersion(sphinx_version) < LooseVersion('1.3.1'):
+        print('Upgrade sphinx to version >= 1.3.1 for '
+              'improved Figure/Table number handling.')
+        # 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)