diff mbox

[dpdk-dev,v2,3/3] doc: add sphinx numref compatibility workaround

Message ID 1431947720-823-4-git-send-email-john.mcnamara@intel.com (mailing list archive)
State Rejected, archived
Headers show

Commit Message

Mcnamara, John May 18, 2015, 11:15 a.m. UTC
From: John McNamara <jmcnamara@cpan.org>

This change adds some simple handling for the :numref: directive
for Sphinx versions prior to 1.3.1. This allows the Guides
documentation to be built with older versions of Sphinx and still
produce reasonable results.

The patch replaces the :numref: reference with a link to the
target (for all Sphinx doc types). It doesn't try to label
figures/tables.

Full numref support with automatic figure/table numbering and
links can be obtained by upgrading to Sphinx 1.3.1 or later.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/conf.py | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)
diff mbox

Patch

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 1bc031f..cab97ac 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -31,6 +31,9 @@ 
 import subprocess
 from sphinx.highlighting import PygmentsBridge
 from pygments.formatters.latex import LatexFormatter
+from docutils import nodes
+from distutils.version import LooseVersion
+from sphinx import __version__ as sphinx_version
 
 project = 'DPDK'
 
@@ -72,6 +75,7 @@  latex_elements = {
     'preamble': latex_preamble
 }
 
+
 # Override the default Latex formatter in order to modify the
 # code/verbatim blocks.
 class CustomLatexFormatter(LatexFormatter):
@@ -82,3 +86,79 @@  class CustomLatexFormatter(LatexFormatter):
 
 # Replace the default latex formatter.
 PygmentsBridge.latex_formatter = CustomLatexFormatter
+
+
+# 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.
+
+    """
+    env = app.builder.env
+
+    # 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 = 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'
+
+            # Create a new reference node with the updated link information.
+            newnode = nodes.reference('',
+                                      caption,
+                                      refuri='%s#%s' % (relative_url, label),
+                                      internal=True)
+
+            # Replace the node.
+            node.replace_self(newnode)
+
+
+def setup(app):
+
+    if LooseVersion(sphinx_version) < LooseVersion('1.3.1'):
+
+        print('[dpdk docs] 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)