[dpdk-dev] [PATCH RFC 0/1] Add 'make pdf' target to convert guide docs to pdf.

John McNamara john.mcnamara at intel.com
Wed Jan 14 18:14:16 CET 2015


This patch adds support for creating PDF versions of the 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 Tex Live '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.

This patch doesn't include PDF generation of the DPDK API document. That will
be submitted later in a separate patch.

I have omitted the 2/2 part of the patch with the PNG files from the RFC.


John McNamara (2):
  doc: Add 'make pdf' target to convert guide docs to pdf.
  doc: Add PNG files for 'make pdf' target.

 doc/api/sphinx-latex-update.pl                     |   71 ++++++++++++++++
 doc/guides/freebsd_gsg/conf.py                     |   86 ++++++++++++++++++++
 doc/guides/freebsd_gsg/img/Intel-logo.png          |  Bin 0 -> 7560 bytes
 doc/guides/linux_gsg/conf.py                       |   86 ++++++++++++++++++++
 doc/guides/linux_gsg/img/Intel-logo.png            |  Bin 0 -> 7560 bytes
 doc/guides/prog_guide/conf.py                      |   86 ++++++++++++++++++++
 doc/guides/prog_guide/img/Intel-logo.png           |  Bin 0 -> 7560 bytes
 .../prog_guide/img/architecture-overview.png       |  Bin 0 -> 69418 bytes
 doc/guides/prog_guide/img/bond-mode-0.png          |  Bin 0 -> 31581 bytes
 doc/guides/prog_guide/img/bond-mode-1.png          |  Bin 0 -> 25550 bytes
 doc/guides/prog_guide/img/bond-mode-2.png          |  Bin 0 -> 33645 bytes
 doc/guides/prog_guide/img/bond-mode-3.png          |  Bin 0 -> 33548 bytes
 doc/guides/prog_guide/img/bond-mode-4.png          |  Bin 0 -> 36763 bytes
 doc/guides/prog_guide/img/bond-mode-5.png          |  Bin 0 -> 40778 bytes
 doc/guides/prog_guide/img/bond-overview.png        |  Bin 0 -> 25065 bytes
 doc/guides/prog_guide/img/linuxapp_launch.png      |  Bin 0 -> 125118 bytes
 doc/guides/prog_guide/img/mbuf1.png                |  Bin 0 -> 37843 bytes
 doc/guides/prog_guide/img/mbuf2.png                |  Bin 0 -> 58682 bytes
 doc/guides/prog_guide/img/memory-management.png    |  Bin 0 -> 22904 bytes
 doc/guides/prog_guide/img/memory-management2.png   |  Bin 0 -> 25411 bytes
 doc/guides/prog_guide/img/mempool.png              |  Bin 0 -> 50966 bytes
 doc/guides/prog_guide/img/multi_process_memory.png |  Bin 0 -> 52930 bytes
 doc/guides/prog_guide/img/ring-dequeue1.png        |  Bin 0 -> 29169 bytes
 doc/guides/prog_guide/img/ring-dequeue2.png        |  Bin 0 -> 30334 bytes
 doc/guides/prog_guide/img/ring-dequeue3.png        |  Bin 0 -> 27677 bytes
 doc/guides/prog_guide/img/ring-enqueue1.png        |  Bin 0 -> 28386 bytes
 doc/guides/prog_guide/img/ring-enqueue2.png        |  Bin 0 -> 29329 bytes
 doc/guides/prog_guide/img/ring-enqueue3.png        |  Bin 0 -> 28907 bytes
 doc/guides/prog_guide/img/ring-modulo1.png         |  Bin 0 -> 21666 bytes
 doc/guides/prog_guide/img/ring-modulo2.png         |  Bin 0 -> 21814 bytes
 doc/guides/prog_guide/img/ring-mp-enqueue1.png     |  Bin 0 -> 35928 bytes
 doc/guides/prog_guide/img/ring-mp-enqueue2.png     |  Bin 0 -> 43924 bytes
 doc/guides/prog_guide/img/ring-mp-enqueue3.png     |  Bin 0 -> 43581 bytes
 doc/guides/prog_guide/img/ring-mp-enqueue4.png     |  Bin 0 -> 43648 bytes
 doc/guides/prog_guide/img/ring-mp-enqueue5.png     |  Bin 0 -> 29787 bytes
 doc/guides/prog_guide/img/ring1.png                |  Bin 0 -> 21466 bytes
 doc/guides/rel_notes/conf.py                       |   85 +++++++++++++++++++
 doc/guides/rel_notes/img/Intel-logo.png            |  Bin 0 -> 7560 bytes
 doc/guides/rel_notes/supported_features.rst        |    2 +-
 doc/guides/sample_app_ug/conf.py                   |   86 ++++++++++++++++++++
 doc/guides/sample_app_ug/img/Intel-logo.png        |  Bin 0 -> 7560 bytes
 doc/guides/sample_app_ug/img/dist_app.png          |  Bin 0 -> 14191 bytes
 doc/guides/sample_app_ug/img/dist_perf.png         |  Bin 0 -> 12355 bytes
 .../sample_app_ug/img/exception_path_example.png   |  Bin 0 -> 57544 bytes
 .../sample_app_ug/img/l2_fwd_benchmark_setup.png   |  Bin 0 -> 21985 bytes
 .../sample_app_ug/img/vm_power_mgr_highlevel.png   |  Bin 0 -> 192526 bytes
 .../img/vm_power_mgr_vm_request_seq.png            |  Bin 0 -> 59573 bytes
 doc/guides/sample_app_ug/img/vmdq_dcb_example.png  |  Bin 0 -> 36777 bytes
 doc/guides/sample_app_ug/test_pipeline.rst         |    6 +-
 doc/guides/testpmd_app_ug/conf.py                  |   85 +++++++++++++++++++
 doc/guides/testpmd_app_ug/img/Intel-logo.png       |  Bin 0 -> 7560 bytes
 mk/rte.sdkdoc.mk                                   |   28 +++++-
 mk/rte.sdkroot.mk                                  |    3 +-
 53 files changed, 614 insertions(+), 10 deletions(-)
 create mode 100644 doc/api/sphinx-latex-update.pl
 create mode 100644 doc/guides/freebsd_gsg/conf.py
 create mode 100644 doc/guides/freebsd_gsg/img/Intel-logo.png
 create mode 100644 doc/guides/linux_gsg/conf.py
 create mode 100644 doc/guides/linux_gsg/img/Intel-logo.png
 create mode 100644 doc/guides/prog_guide/conf.py
 create mode 100644 doc/guides/prog_guide/img/Intel-logo.png
 create mode 100644 doc/guides/prog_guide/img/architecture-overview.png
 create mode 100644 doc/guides/prog_guide/img/bond-mode-0.png
 create mode 100644 doc/guides/prog_guide/img/bond-mode-1.png
 create mode 100644 doc/guides/prog_guide/img/bond-mode-2.png
 create mode 100644 doc/guides/prog_guide/img/bond-mode-3.png
 create mode 100644 doc/guides/prog_guide/img/bond-mode-4.png
 create mode 100644 doc/guides/prog_guide/img/bond-mode-5.png
 create mode 100644 doc/guides/prog_guide/img/bond-overview.png
 create mode 100644 doc/guides/prog_guide/img/linuxapp_launch.png
 create mode 100644 doc/guides/prog_guide/img/mbuf1.png
 create mode 100644 doc/guides/prog_guide/img/mbuf2.png
 create mode 100644 doc/guides/prog_guide/img/memory-management.png
 create mode 100644 doc/guides/prog_guide/img/memory-management2.png
 create mode 100644 doc/guides/prog_guide/img/mempool.png
 create mode 100644 doc/guides/prog_guide/img/multi_process_memory.png
 create mode 100644 doc/guides/prog_guide/img/ring-dequeue1.png
 create mode 100644 doc/guides/prog_guide/img/ring-dequeue2.png
 create mode 100644 doc/guides/prog_guide/img/ring-dequeue3.png
 create mode 100644 doc/guides/prog_guide/img/ring-enqueue1.png
 create mode 100644 doc/guides/prog_guide/img/ring-enqueue2.png
 create mode 100644 doc/guides/prog_guide/img/ring-enqueue3.png
 create mode 100644 doc/guides/prog_guide/img/ring-modulo1.png
 create mode 100644 doc/guides/prog_guide/img/ring-modulo2.png
 create mode 100644 doc/guides/prog_guide/img/ring-mp-enqueue1.png
 create mode 100644 doc/guides/prog_guide/img/ring-mp-enqueue2.png
 create mode 100644 doc/guides/prog_guide/img/ring-mp-enqueue3.png
 create mode 100644 doc/guides/prog_guide/img/ring-mp-enqueue4.png
 create mode 100644 doc/guides/prog_guide/img/ring-mp-enqueue5.png
 create mode 100644 doc/guides/prog_guide/img/ring1.png
 create mode 100644 doc/guides/rel_notes/conf.py
 create mode 100644 doc/guides/rel_notes/img/Intel-logo.png
 create mode 100644 doc/guides/sample_app_ug/conf.py
 create mode 100644 doc/guides/sample_app_ug/img/Intel-logo.png
 create mode 100644 doc/guides/sample_app_ug/img/dist_app.png
 create mode 100644 doc/guides/sample_app_ug/img/dist_perf.png
 create mode 100644 doc/guides/sample_app_ug/img/exception_path_example.png
 create mode 100644 doc/guides/sample_app_ug/img/l2_fwd_benchmark_setup.png
 create mode 100644 doc/guides/sample_app_ug/img/vm_power_mgr_highlevel.png
 create mode 100644 doc/guides/sample_app_ug/img/vm_power_mgr_vm_request_seq.png
 create mode 100644 doc/guides/sample_app_ug/img/vmdq_dcb_example.png
 create mode 100644 doc/guides/testpmd_app_ug/conf.py
 create mode 100644 doc/guides/testpmd_app_ug/img/Intel-logo.png

-- 
1.7.4.1



More information about the dev mailing list