[dpdk-dev,v2] doc: remove dejavu font from doc build
Commit Message
Remove requirement for occasionally hard to find/install
DejaVuSansMono font. It isn't gnerally required anyway.
The default mono font is sufficient.
Signed-off-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
---
doc/guides/conf.py | 1 -
doc/guides/contributing/documentation.rst | 20 ++++++++------------
pkg/dpdk.spec | 2 +-
3 files changed, 9 insertions(+), 14 deletions(-)
Comments
2015-11-01 14:13, John McNamara:
> Remove requirement for occasionally hard to find/install
> DejaVuSansMono font. It isn't gnerally required anyway.
> The default mono font is sufficient.
>
> Signed-off-by: John McNamara <john.mcnamara@intel.com>
> Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
[...]
> --- a/doc/guides/contributing/documentation.rst
> +++ b/doc/guides/contributing/documentation.rst
> -* TexLive (at least TexLive-core, extra Latex support and extra fonts).
> +* TexLive.
Why not keep minimum requirements? (TexLive-core and extra Latex support)
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Sunday, November 1, 2015 3:00 PM
> To: Mcnamara, John
> Cc: dev@dpdk.org
> Subject: Re: [PATCH v2] doc: remove dejavu font from doc build
>
> Why not keep minimum requirements? (TexLive-core and extra Latex support)
Hi,
Mainly because the requirements are now at the minimum with only one package required.
John.
--
2015-11-01 16:35, Mcnamara, John:
> > -----Original Message-----
> > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > Sent: Sunday, November 1, 2015 3:00 PM
> > To: Mcnamara, John
> > Cc: dev@dpdk.org
> > Subject: Re: [PATCH v2] doc: remove dejavu font from doc build
> >
> > Why not keep minimum requirements? (TexLive-core and extra Latex support)
>
> Hi,
>
> Mainly because the requirements are now at the minimum with only one package required.
If we don't give tips about how to install a minimum texlive, it means we
have to install the whole texlive distribution which is a huge dependency.
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Sunday, November 1, 2015 6:32 PM
> To: Mcnamara, John
> Cc: dev@dpdk.org
> Subject: Re: [PATCH v2] doc: remove dejavu font from doc build
>
> 2015-11-01 16:35, Mcnamara, John:
> > > -----Original Message-----
> > > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > > Sent: Sunday, November 1, 2015 3:00 PM
> > > To: Mcnamara, John
> > > Cc: dev@dpdk.org
> > > Subject: Re: [PATCH v2] doc: remove dejavu font from doc build
> > Mainly because the requirements are now at the minimum with only one
> package required.
>
> If we don't give tips about how to install a minimum texlive, it means we
> have to install the whole texlive distribution which is a huge dependency.
Ok. I'll put that back in.
@@ -59,7 +59,6 @@ latex_documents = [
# 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}
@@ -142,7 +142,7 @@ The following dependencies must be installed to build the documentation:
* Sphinx (also called python-sphinx).
-* TexLive (at least TexLive-core, extra Latex support and extra fonts).
+* TexLive.
* Inkscape.
@@ -158,18 +158,17 @@ It can be installed as follows:
sudo yum -y install doxygen
`Sphinx`_ is a Python documentation tool for converting RST files to Html or to PDF (via LaTeX).
-It can be installed as follows:
+For full support with figure and table captioning the latest version of Sphinx can be installed as follows:
.. code-block:: console
# Ubuntu/Debian.
- sudo apt-get -y install python-sphinx
+ sudo apt-get -y install python-pip
+ sudo pip install --upgrade sphinx
# Red Hat/Fedora.
- sudo yum -y install python-sphinx
-
- # Or, on any system with Python installed.
- sudo easy_install -U sphinx
+ sudo yum -y install python-pip
+ sudo pip install --upgrade sphinx
For further information on getting started with Sphinx see the `Sphinx Tutorial <http://sphinx-doc.org/tutorial.html>`_.
@@ -196,13 +195,10 @@ The main required packages can be installed as follows:
.. code-block:: console
# Ubuntu/Debian.
- sudo apt-get -y install texlive-latex-extra texlive-fonts-extra \
- texlive-fonts-recommended
-
+ sudo apt-get -y install texlive-latex-extra
# Red Hat/Fedora, selective install.
- sudo yum -y install texlive-collection-latexextra \
- texlive-collection-fontsextra
+ sudo yum -y install texlive-collection-latexextra
Build commands
@@ -46,7 +46,7 @@ ExclusiveArch: i686, x86_64
BuildRequires: kernel-devel, kernel-headers, libpcap-devel, xen-devel
BuildRequires: doxygen, python-sphinx, inkscape
-BuildRequires: texlive-collection-latexextra, texlive-collection-fontsextra
+BuildRequires: texlive-collection-latexextra
%description
DPDK core includes kernel modules, core libraries and tools.