[dpdk-dev] [PATCH v4 0/5] doc: Add 'make pdf' target to convert guide docs to pdf

[John McNamara]

This patch adds support for creating PDF versions of the user guides.

Specifically:

    * The Programmer's Guide
    * The Linux Getting Started Guide
    * The FreeBSD Getting Started Guide
    * The Sample Applications User Guide
    * The TestPMD User Guide
    * The Release Notes

The local and online Html documentation is very useful but we have had
internal and external requests from people who also liked the PDF
documentation in older releases.

The PDF generation is fully automated and uses the same Sphinx build system
and RST files used for the Html docs but uses the 'latexpdf' target. In
addition to the standard Sphinx Python modules it requires the Tex/LaTeX
toolchain. For best results it requires a TexLive 'Full' installation.

The PDF documents are generated as follows:

    make pdf
    # or
    make doc-pdf

The PDFs aren't generated as part of the 'make doc' rule since they can take
some 1-3 minutes to build and since they have a large toolchain dependency.

V4 Changes:
    * Changed RST image types to wildcard to allow Sphinx to decide
      the appropriate type.
    * Changed back to calling Sphinx generated makefile to ensure that
      the pdf files are created by Sphinx make rules.

V3 Changes:
    * Remove sub-directory config.py files and replaced them with metadata
      in the main doc/guides/conf.py file and a more generic make rule.
    * Added *.pdf targets with *.rst dependencies.
    * Call pdflatex directly (instead of from Sphinx) to control the
      verbosity of the output.

V2 Changes:
    * Removes config file duplication
    * Converts SVG files to PNG on the fly
    * Splits the patch into distinct mk/doc parts
    * Fixes issues in the RST docs that prevent PDF generation


John McNamara (5):
  mk: Add 'make doc-pdf' target to convert guide docs to pdf
  doc: Add Sphinx config to build pdf version of guides
  doc: Fix encoding of (r) character
  doc: Refactored split cell formatting in one table
  doc: Convert image extensions to wildcard

 doc/guides/conf.py                                 |   48 ++++++++++++++++++-
 doc/guides/prog_guide/env_abstraction_layer.rst    |    2 +-
 .../prog_guide/i40e_ixgbe_igb_virt_func_drv.rst    |    8 ++--
 .../intel_dpdk_xen_based_packet_switch_sol.rst     |    6 +-
 doc/guides/prog_guide/ivshmem_lib.rst              |    2 +-
 doc/guides/prog_guide/kernel_nic_interface.rst     |    8 ++--
 .../libpcap_ring_based_poll_mode_drv.rst           |    2 +-
 .../prog_guide/link_bonding_poll_mode_drv_lib.rst  |   14 +++---
 doc/guides/prog_guide/lpm6_lib.rst                 |    2 +-
 doc/guides/prog_guide/lpm_lib.rst                  |    2 +-
 doc/guides/prog_guide/malloc_lib.rst               |    2 +-
 doc/guides/prog_guide/mbuf_lib.rst                 |    4 +-
 doc/guides/prog_guide/mempool_lib.rst              |    6 +-
 doc/guides/prog_guide/multi_proc_support.rst       |    2 +-
 doc/guides/prog_guide/overview.rst                 |    2 +-
 doc/guides/prog_guide/packet_distrib_lib.rst       |    4 +-
 doc/guides/prog_guide/packet_framework.rst         |   14 +++---
 .../poll_mode_drv_emulated_virtio_nic.rst          |    6 +-
 .../poll_mode_drv_paravirtual_vmxnets_nic.rst      |    6 +-
 doc/guides/prog_guide/qos_framework.rst            |   36 +++++++-------
 doc/guides/prog_guide/ring_lib.rst                 |   28 ++++++------
 doc/guides/rel_notes/supported_features.rst        |    2 +-
 doc/guides/sample_app_ug/dist_app.rst              |    4 +-
 doc/guides/sample_app_ug/exception_path.rst        |    2 +-
 doc/guides/sample_app_ug/intel_quickassist.rst     |    2 +-
 doc/guides/sample_app_ug/kernel_nic_interface.rst  |    4 +-
 .../sample_app_ug/l2_forward_real_virtual.rst      |    4 +-
 .../sample_app_ug/l3_forward_access_ctrl.rst       |    4 +-
 doc/guides/sample_app_ug/load_balancer.rst         |    2 +-
 doc/guides/sample_app_ug/multi_process.rst         |    8 ++--
 doc/guides/sample_app_ug/qos_scheduler.rst         |    2 +-
 doc/guides/sample_app_ug/quota_watermark.rst       |    6 +-
 doc/guides/sample_app_ug/test_pipeline.rst         |   34 +++++++++-----
 doc/guides/sample_app_ug/vhost.rst                 |   10 ++--
 doc/guides/sample_app_ug/vm_power_management.rst   |    4 +-
 doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst   |    2 +-
 mk/rte.sdkdoc.mk                                   |   43 +++++++++++++++++-
 37 files changed, 216 insertions(+), 121 deletions(-)

-- 
1.7.4.1