[spp] [PATCH 00/11] PDF documentation support

ogawa.yasufumi at lab.ntt.co.jp ogawa.yasufumi at lab.ntt.co.jp
Fri Aug 31 11:14:30 CEST 2018


From: Yasufumi Ogawa <ogawa.yasufumi at lab.ntt.co.jp>

This series of patches is for adding PDF documentation support.
It includes following changes.

* Move all of embedded images to 'images' directory.

* Resize images to fit the PDF document.

* Add a script for generating PDF images from SVGs because SVG images
  cannot be embedded in the PDF document.

* Revise Makefile for generating PDF document.

* Correct lines character length because characters after 80th is not
  shown in PDF document.

* Correct label name to fix undefined label warning.


Yasufumi Ogawa (11):
  docs: move SPP VF images
  docs: resize figures of SPP VF
  docs: resize figures of SPP
  docs: resize figures of SPP container
  docs: add script for generating PDF images
  project: update gitignore to exclude PDF files
  docs: add sphinx config to PDF
  makefile: add make option to compile PDF doc
  makefile: fix bug of PDF compilation
  docs: refactor for character length
  docs: fix typo of label

 .gitignore                                      |    1 +
 Makefile                                        |   16 +-
 docs/guides/commands/experimental.rst           |    6 +-
 docs/guides/compile-doc.sh                      |    9 -
 docs/guides/conf.py                             |    7 +-
 docs/guides/gen_pdf_imgs.py                     |   50 +
 docs/guides/images/spp_vf/spp_sample_config.svg | 1916 +++++++++++++++++++++++
 docs/guides/images/spp_vf/spp_vf_overview.svg   | 1149 ++++++++++++++
 docs/guides/images/spp_vf/usecase1_nwconfig.svg | 1916 +++++++++++++++++++++++
 docs/guides/images/spp_vf/usecase1_overview.svg |  411 +++++
 docs/guides/overview.rst                        |   10 +-
 docs/guides/setup/getting_started.rst           |   16 +-
 docs/guides/setup/howto_use.rst                 |    9 +-
 docs/guides/setup/performance_opt.rst           |   16 +-
 docs/guides/setup/use_cases.rst                 |   24 +-
 docs/guides/spp_vf/commands/secondary.rst       |   22 +-
 docs/guides/spp_vf/design.rst                   |    7 +-
 docs/guides/spp_vf/gsg/build.rst                |   59 +-
 docs/guides/spp_vf/images/spp_sample_config.svg | 1916 -----------------------
 docs/guides/spp_vf/images/spp_vf_overview.svg   | 1149 --------------
 docs/guides/spp_vf/images/usecase1_nwconfig.svg | 1916 -----------------------
 docs/guides/spp_vf/images/usecase1_overview.svg |  411 -----
 docs/guides/spp_vf/overview.rst                 |    7 +-
 docs/guides/spp_vf/use_cases/usecase1.rst       |   10 +-
 docs/guides/tools/sppc/app_launcher.rst         |   20 +-
 docs/guides/tools/sppc/getting_started.rst      |    3 +-
 docs/guides/tools/sppc/howto_launcher.rst       |    4 +-
 docs/guides/tools/sppc/overview.rst             |    3 +-
 docs/guides/tools/sppc/usecases.rst             |   15 +-
 29 files changed, 5581 insertions(+), 5517 deletions(-)
 delete mode 100644 docs/guides/compile-doc.sh
 create mode 100644 docs/guides/gen_pdf_imgs.py
 create mode 100644 docs/guides/images/spp_vf/spp_sample_config.svg
 create mode 100644 docs/guides/images/spp_vf/spp_vf_overview.svg
 create mode 100644 docs/guides/images/spp_vf/usecase1_nwconfig.svg
 create mode 100644 docs/guides/images/spp_vf/usecase1_overview.svg
 delete mode 100644 docs/guides/spp_vf/images/spp_sample_config.svg
 delete mode 100644 docs/guides/spp_vf/images/spp_vf_overview.svg
 delete mode 100644 docs/guides/spp_vf/images/usecase1_nwconfig.svg
 delete mode 100644 docs/guides/spp_vf/images/usecase1_overview.svg

-- 
2.7.4



More information about the spp mailing list