From: ogawa.yasufumi@lab.ntt.co.jp
To: spp@dpdk.org, ferruh.yigit@intel.com
Cc: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
Subject: [spp] [PATCH 00/11] PDF documentation support
Date: Fri, 31 Aug 2018 18:14:30 +0900 [thread overview]
Message-ID: <20180831091441.39055-1-ogawa.yasufumi@lab.ntt.co.jp> (raw)
From: Yasufumi Ogawa <ogawa.yasufumi@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
next reply other threads:[~2018-08-31 9:14 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-08-31 9:14 ogawa.yasufumi [this message]
2018-08-31 9:14 ` [spp] [PATCH 01/11] docs: move SPP VF images ogawa.yasufumi
2018-08-31 9:14 ` [spp] [PATCH 02/11] docs: resize figures of SPP VF ogawa.yasufumi
2018-08-31 9:14 ` [spp] [PATCH 03/11] docs: resize figures of SPP ogawa.yasufumi
2018-08-31 9:14 ` [spp] [PATCH 04/11] docs: resize figures of SPP container ogawa.yasufumi
2018-08-31 9:14 ` [spp] [PATCH 05/11] docs: add script for generating PDF images ogawa.yasufumi
2018-08-31 9:14 ` [spp] [PATCH 06/11] project: update gitignore to exclude PDF files ogawa.yasufumi
2018-08-31 9:14 ` [spp] [PATCH 07/11] docs: add sphinx config to PDF ogawa.yasufumi
2018-08-31 9:14 ` [spp] [PATCH 08/11] makefile: add make option to compile PDF doc ogawa.yasufumi
2018-08-31 9:14 ` [spp] [PATCH 09/11] makefile: fix bug of PDF compilation ogawa.yasufumi
2018-08-31 9:14 ` [spp] [PATCH 10/11] docs: refactor for character length ogawa.yasufumi
2018-08-31 9:14 ` [spp] [PATCH 11/11] docs: fix typo of label ogawa.yasufumi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180831091441.39055-1-ogawa.yasufumi@lab.ntt.co.jp \
--to=ogawa.yasufumi@lab.ntt.co.jp \
--cc=ferruh.yigit@intel.com \
--cc=spp@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).