From: John McNamara <john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
To: dev-VfR2kkLFssw@public.gmane.org
Subject: [PATCH v3 2/4] doc: Add Sphinx config to build pdf version of guides
Date: Mon, 2 Feb 2015 13:16:05 +0000 [thread overview]
Message-ID: <1422882967-27060-3-git-send-email-john.mcnamara@intel.com> (raw)
In-Reply-To: <1422882967-27060-1-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
Add Python Sphinx config to allow conversion of guides
to Latex and then PDF format.
This mainly adds metadata but also includes an override to the
Latex formatter to control the font size in code blocks.
Signed-off-by: John McNamara <john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---
doc/guides/conf.py | 44 +++++++++++++++++++++++++++++++++++++++++++-
1 files changed, 43 insertions(+), 1 deletions(-)
diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 385af03..9f546bd 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -29,11 +29,53 @@
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
import subprocess
+from sphinx.highlighting import PygmentsBridge
+from pygments.formatters.latex import LatexFormatter
project = 'DPDK'
copyright = '2014, Intel'
-version = subprocess.check_output(["make","-sRrC","../../", "showversion"])
+version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion'])
+release = version
master_doc = 'index'
+
+# Latex directives to be included directly in the latex/pdf docs.
+latex_preamble = r"""
+\usepackage[utf8]{inputenc}
+\usepackage{DejaVuSansMono}
+\usepackage[T1]{fontenc}
+\usepackage{helvet}
+\renewcommand{\familydefault}{\sfdefault}
+
+\RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm}
+"""
+
+# Configuration for the latex/pdf docs.
+latex_elements = {
+ 'papersize': 'a4paper',
+ 'pointsize': '11pt',
+ 'preamble': latex_preamble}
+
+latex_documents = [
+ ('index',
+ 'dpdk_doc.tex',
+ '',
+ '',
+ 'manual')]
+
+
+# Temp class to override the default Latex formatter in order to modify the
+# font size in the code/verbatim blocks.
+class CustomLatexFormatter(LatexFormatter):
+
+ def __init__(self, **options):
+
+ super(CustomLatexFormatter, self).__init__(**options)
+
+ # Use the second smallest font size for code/verbatim blocks.
+ self.verboptions = r'formatcom=\footnotesize'
+
+# Replace the default latex formatter.
+PygmentsBridge.latex_formatter = CustomLatexFormatter
--
1.7.4.1
next prev parent reply other threads:[~2015-02-02 13:16 UTC|newest]
Thread overview: 51+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-01-14 17:14 [PATCH RFC 0/1] Add 'make pdf' target to convert guide docs to pdf John McNamara
[not found] ` <1421255657-19521-1-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2015-01-14 17:14 ` [PATCH 1/2] doc: " John McNamara
2015-01-30 18:13 ` [PATCH v2 0/4] " John McNamara
[not found] ` <1422641608-8514-1-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2015-01-30 18:13 ` [PATCH v2 1/4] mk: Add 'make doc-pdf' " John McNamara
[not found] ` <1422641608-8514-2-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2015-01-30 20:52 ` Thomas Monjalon
2015-02-02 13:10 ` Mcnamara, John
[not found] ` <B27915DBBA3421428155699D51E4CFE2EAC4D2-kPTMFJFq+rELt2AQoY/u9bfspsVTdybXVpNB7YpNyf8@public.gmane.org>
2015-02-02 13:35 ` Thomas Monjalon
2015-02-03 13:24 ` Mcnamara, John
2015-01-30 18:13 ` [PATCH v2 2/4] doc: Add Sphinx config to build pdf version of guides John McNamara
[not found] ` <1422641608-8514-3-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2015-01-30 21:03 ` Thomas Monjalon
2015-02-02 10:19 ` Iremonger, Bernard
[not found] ` <8CEF83825BEC744B83065625E567D7C2049DC928-kPTMFJFq+rEMvF1YICWikbfspsVTdybXVpNB7YpNyf8@public.gmane.org>
2015-02-02 10:25 ` Thomas Monjalon
2015-02-02 10:28 ` Iremonger, Bernard
2015-01-30 18:13 ` [PATCH v2 3/4] doc: Fix encoding of (r) character John McNamara
2015-01-30 18:13 ` [PATCH v2 4/4] doc: Refactored split cell formatting in one table John McNamara
[not found] ` <1422641608-8514-5-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2015-01-30 21:05 ` Thomas Monjalon
2015-01-30 20:25 ` [PATCH v2 0/4] doc: Add 'make pdf' target to convert guide docs to pdf Thomas Monjalon
2015-02-02 13:16 ` [PATCH v3 " John McNamara
[not found] ` <1422882967-27060-1-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2015-02-02 13:16 ` [PATCH v3 1/4] mk: Add 'make doc-pdf' " John McNamara
2015-02-02 13:16 ` John McNamara [this message]
[not found] ` <1422882967-27060-3-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2015-02-03 10:30 ` [PATCH v3 2/4] doc: Add Sphinx config to build pdf version of guides Iremonger, Bernard
2015-02-02 13:16 ` [PATCH v3 3/4] doc: Fix encoding of (r) character John McNamara
2015-02-02 13:16 ` [PATCH v3 4/4] doc: Refactored split cell formatting in one table John McNamara
2015-02-03 14:11 ` [PATCH v4 0/5] doc: Add 'make pdf' target to convert guide docs to pdf John McNamara
[not found] ` <1422972678-7982-1-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2015-02-03 14:11 ` [PATCH v4 1/5] mk: Add 'make doc-pdf' " John McNamara
[not found] ` <1422972678-7982-2-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2015-02-16 12:19 ` Iremonger, Bernard
[not found] ` <8CEF83825BEC744B83065625E567D7C2049E7F31-kPTMFJFq+rEMvF1YICWikbfspsVTdybXVpNB7YpNyf8@public.gmane.org>
2015-02-16 12:55 ` Mcnamara, John
2015-02-16 14:16 ` Iremonger, Bernard
2015-02-03 14:11 ` [PATCH v4 2/5] doc: Add Sphinx config to build pdf version of guides John McNamara
[not found] ` <1422972678-7982-3-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2015-02-16 14:20 ` Iremonger, Bernard
2015-02-03 14:11 ` [PATCH v4 3/5] doc: Fix encoding of (r) character John McNamara
[not found] ` <1422972678-7982-4-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2015-02-13 14:29 ` Iremonger, Bernard
[not found] ` <8CEF83825BEC744B83065625E567D7C2049E0436-kPTMFJFq+rEMvF1YICWikbfspsVTdybXVpNB7YpNyf8@public.gmane.org>
2015-02-13 15:59 ` Mcnamara, John
[not found] ` <B27915DBBA3421428155699D51E4CFE2EC267F-kPTMFJFq+rELt2AQoY/u9bfspsVTdybXVpNB7YpNyf8@public.gmane.org>
2015-02-13 16:42 ` Iremonger, Bernard
2015-02-16 14:22 ` Iremonger, Bernard
2015-02-03 14:11 ` [PATCH v4 4/5] doc: Refactored split cell formatting in one table John McNamara
[not found] ` <1422972678-7982-5-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2015-02-16 14:23 ` Iremonger, Bernard
2015-02-03 14:11 ` [PATCH v4 5/5] doc: Convert image extensions to wildcard John McNamara
[not found] ` <1422972678-7982-6-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2015-02-16 12:09 ` Iremonger, Bernard
[not found] ` <8CEF83825BEC744B83065625E567D7C2049E7F0E-kPTMFJFq+rEMvF1YICWikbfspsVTdybXVpNB7YpNyf8@public.gmane.org>
2015-02-16 12:43 ` Mcnamara, John
2015-02-16 14:25 ` Iremonger, Bernard
2015-03-19 11:23 ` [PATCH v5 0/7] add doc-guides-pdf target Thomas Monjalon
[not found] ` <1426764204-3882-1-git-send-email-thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
2015-03-19 11:23 ` [PATCH v5 1/7] doc: fix encoding of (r) character Thomas Monjalon
2015-03-19 11:23 ` [PATCH v5 2/7] doc: refactor split cell formatting in table Thomas Monjalon
2015-03-19 11:23 ` [PATCH v5 3/7] doc: convert image extensions to wildcard Thomas Monjalon
2015-03-19 11:23 ` [PATCH v5 4/7] doc: add pdf output Thomas Monjalon
2015-03-19 11:23 ` [PATCH v5 5/7] doc: fix version for python 3 Thomas Monjalon
2015-03-19 11:23 ` [PATCH v5 6/7] doc: tune pdf fonts Thomas Monjalon
2015-03-19 11:23 ` [PATCH v5 7/7] doc: remove blank pages in pdf Thomas Monjalon
2015-03-19 13:47 ` [PATCH v5 0/7] add doc-guides-pdf target Mcnamara, John
[not found] ` <B27915DBBA3421428155699D51E4CFE2ED346C-kPTMFJFq+rELt2AQoY/u9bfspsVTdybXVpNB7YpNyf8@public.gmane.org>
2015-03-19 17:04 ` Thomas Monjalon
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=1422882967-27060-3-git-send-email-john.mcnamara@intel.com \
--to=john.mcnamara-ral2jqcrhueavxtiumwx3w@public.gmane.org \
--cc=dev-VfR2kkLFssw@public.gmane.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).