doc/guides/conf.py

   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
  31 import subprocess
  32 from docutils import nodes
  33 from distutils.version import LooseVersion
  34 from sphinx import __version__ as sphinx_version
  35 from sphinx.highlighting import PygmentsBridge
  36 from pygments.formatters.latex import LatexFormatter
  37
  38 project = 'DPDK'
  39
  40 html_add_permalinks = ""
  41 html_show_copyright = False
  42 highlight_language = 'none'
  43
  44 version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion']).decode('utf-8')
  45 release = version
  46
  47 master_doc = 'index'
  48
  49 # Figures, tables and code-blocks automatically numbered if they have caption
  50 numfig = True
  51
  52 latex_documents = [
  53     ('index',
  54      'doc.tex',
  55      '',
  56      '',
  57      'manual')
  58 ]
  59
  60 # Latex directives to be included directly in the latex/pdf docs.
  61 latex_preamble = r"""
  62 \usepackage[utf8]{inputenc}
  63 \usepackage[T1]{fontenc}
  64 \usepackage{helvet}
  65 \renewcommand{\familydefault}{\sfdefault}
  66 \RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm}
  67 """
  68
  69 # Configuration for the latex/pdf docs.
  70 latex_elements = {
  71     'papersize': 'a4paper',
  72     'pointsize': '11pt',
  73     # remove blank pages
  74     'classoptions': ',openany,oneside',
  75     'babel': '\\usepackage[english]{babel}',
  76     # customize Latex formatting
  77     'preamble': latex_preamble
  78 }
  79
  80 # Override the default Latex formatter in order to modify the
  81 # code/verbatim blocks.
  82 class CustomLatexFormatter(LatexFormatter):
  83     def __init__(self, **options):
  84         super(CustomLatexFormatter, self).__init__(**options)
  85         # Use the second smallest font size for code/verbatim blocks.
  86         self.verboptions = r'formatcom=\footnotesize'
  87
  88 # Replace the default latex formatter.
  89 PygmentsBridge.latex_formatter = CustomLatexFormatter
  90
  91 ######## :numref: fallback ########
  92 # The following hook functions add some simple handling for the :numref:
  93 # directive for Sphinx versions prior to 1.3.1. The functions replace the
  94 # :numref: reference with a link to the target (for all Sphinx doc types).
  95 # It doesn't try to label figures/tables.
  96
  97 def numref_role(reftype, rawtext, text, lineno, inliner):
  98     """
  99     Add a Sphinx role to handle numref references. Note, we can't convert
 100     the link here because the doctree isn't build and the target information
 101     isn't available.
 102     """
 103     # Add an identifier to distinguish numref from other references.
 104     newnode = nodes.reference('',
 105                               '',
 106                               refuri='_local_numref_#%s' % text,
 107                               internal=True)
 108     return [newnode], []
 109
 110 def process_numref(app, doctree, from_docname):
 111     """
 112     Process the numref nodes once the doctree has been built and prior to
 113     writing the files. The processing involves replacing the numref with a
 114     link plus text to indicate if it is a Figure or Table link.
 115     """
 116
 117     # Iterate over the reference nodes in the doctree.
 118     for node in doctree.traverse(nodes.reference):
 119         target = node.get('refuri', '')
 120
 121         # Look for numref nodes.
 122         if target.startswith('_local_numref_#'):
 123             target = target.replace('_local_numref_#', '')
 124
 125             # Get the target label and link information from the Sphinx env.
 126             data = app.builder.env.domains['std'].data
 127             docname, label, _ = data['labels'].get(target, ('', '', ''))
 128             relative_url = app.builder.get_relative_uri(from_docname, docname)
 129
 130             # Add a text label to the link.
 131             if target.startswith('figure'):
 132                 caption = 'Figure'
 133             elif target.startswith('table'):
 134                 caption = 'Table'
 135             else:
 136                 caption = 'Link'
 137
 138             # New reference node with the updated link information.
 139             newnode = nodes.reference('',
 140                                       caption,
 141                                       refuri='%s#%s' % (relative_url, label),
 142                                       internal=True)
 143             node.replace_self(newnode)
 144
 145 def setup(app):
 146     if LooseVersion(sphinx_version) < LooseVersion('1.3.1'):
 147         print('Upgrade sphinx to version >= 1.3.1 for '
 148               'improved Figure/Table number handling.')
 149         # Add a role to handle :numref: references.
 150         app.add_role('numref', numref_role)
 151         # Process the numref references once the doctree has been created.
 152         app.connect('doctree-resolved', process_numref)