1# BSD LICENSE 2# Copyright(c) 2010-2015 Intel Corporation. All rights reserved. 3# All rights reserved. 4# 5# Redistribution and use in source and binary forms, with or without 6# modification, are permitted provided that the following conditions 7# are met: 8# 9# * Redistributions of source code must retain the above copyright 10# notice, this list of conditions and the following disclaimer. 11# * Redistributions in binary form must reproduce the above copyright 12# notice, this list of conditions and the following disclaimer in 13# the documentation and/or other materials provided with the 14# distribution. 15# * Neither the name of Intel Corporation nor the names of its 16# contributors may be used to endorse or promote products derived 17# from this software without specific prior written permission. 18# 19# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31import subprocess 32from docutils import nodes 33from distutils.version import LooseVersion 34from sphinx import __version__ as sphinx_version 35from sphinx.highlighting import PygmentsBridge 36from pygments.formatters.latex import LatexFormatter 37 38project = 'DPDK' 39 40html_show_copyright = False 41 42version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion']).decode('utf-8') 43release = version 44 45master_doc = 'index' 46 47# Figures, tables and code-blocks automatically numbered if they have caption 48numfig = True 49 50latex_documents = [ 51 ('index', 52 'doc.tex', 53 '', 54 '', 55 'manual') 56] 57 58# Latex directives to be included directly in the latex/pdf docs. 59latex_preamble = r""" 60\usepackage[utf8]{inputenc} 61\usepackage{DejaVuSansMono} 62\usepackage[T1]{fontenc} 63\usepackage{helvet} 64\renewcommand{\familydefault}{\sfdefault} 65\RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm} 66""" 67 68# Configuration for the latex/pdf docs. 69latex_elements = { 70 'papersize': 'a4paper', 71 'pointsize': '11pt', 72 # remove blank pages 73 'classoptions': ',openany,oneside', 74 'babel': '\\usepackage[english]{babel}', 75 # customize Latex formatting 76 'preamble': latex_preamble 77} 78 79# Override the default Latex formatter in order to modify the 80# code/verbatim blocks. 81class CustomLatexFormatter(LatexFormatter): 82 def __init__(self, **options): 83 super(CustomLatexFormatter, self).__init__(**options) 84 # Use the second smallest font size for code/verbatim blocks. 85 self.verboptions = r'formatcom=\footnotesize' 86 87# Replace the default latex formatter. 88PygmentsBridge.latex_formatter = CustomLatexFormatter 89 90######## :numref: fallback ######## 91# The following hook functions add some simple handling for the :numref: 92# directive for Sphinx versions prior to 1.3.1. The functions replace the 93# :numref: reference with a link to the target (for all Sphinx doc types). 94# It doesn't try to label figures/tables. 95 96def numref_role(reftype, rawtext, text, lineno, inliner): 97 """ 98 Add a Sphinx role to handle numref references. Note, we can't convert 99 the link here because the doctree isn't build and the target information 100 isn't available. 101 """ 102 # Add an identifier to distinguish numref from other references. 103 newnode = nodes.reference('', 104 '', 105 refuri='_local_numref_#%s' % text, 106 internal=True) 107 return [newnode], [] 108 109def process_numref(app, doctree, from_docname): 110 """ 111 Process the numref nodes once the doctree has been built and prior to 112 writing the files. The processing involves replacing the numref with a 113 link plus text to indicate if it is a Figure or Table link. 114 """ 115 116 # Iterate over the reference nodes in the doctree. 117 for node in doctree.traverse(nodes.reference): 118 target = node.get('refuri', '') 119 120 # Look for numref nodes. 121 if target.startswith('_local_numref_#'): 122 target = target.replace('_local_numref_#', '') 123 124 # Get the target label and link information from the Sphinx env. 125 data = app.builder.env.domains['std'].data 126 docname, label, _ = data['labels'].get(target, ('', '', '')) 127 relative_url = app.builder.get_relative_uri(from_docname, docname) 128 129 # Add a text label to the link. 130 if target.startswith('figure'): 131 caption = 'Figure' 132 elif target.startswith('table'): 133 caption = 'Table' 134 else: 135 caption = 'Link' 136 137 # New reference node with the updated link information. 138 newnode = nodes.reference('', 139 caption, 140 refuri='%s#%s' % (relative_url, label), 141 internal=True) 142 node.replace_self(newnode) 143 144def setup(app): 145 if LooseVersion(sphinx_version) < LooseVersion('1.3.1'): 146 print('Upgrade sphinx to version >= 1.3.1 for ' 147 'improved Figure/Table number handling.') 148 # Add a role to handle :numref: references. 149 app.add_role('numref', numref_role) 150 # Process the numref references once the doctree has been created. 151 app.connect('doctree-resolved', process_numref) 152