[dpdk-dev] [PATCH] doc: remove dejavu font from doc build

[dpdk-dev] [PATCH] doc: remove dejavu font from doc build

[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>
---
 doc/guides/conf.py | 1 -
 1 file changed, 1 deletion(-)

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 8cfb7d3..e060462 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -61,7 +61,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}
-- 
1.8.1.4

Re: [dpdk-dev] [PATCH] doc: remove dejavu font from doc build

[Van Haaren, Harry]

> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of John McNamara
> Sent: Tuesday, October 20, 2015 12:32 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: remove dejavu font from doc build
> 
> 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>

Re: [dpdk-dev] [PATCH] doc: remove dejavu font from doc build

[Thomas Monjalon]

2015-10-20 12:32, John McNamara:
> Remove requirement for occasionally hard to find/install
> DejaVuSansMono font. It isn't gnerally required anyway.
> The default mono font is sufficient.

Does it remove the need for texlive-collection-fontsextra?

Re: [dpdk-dev] [PATCH] doc: remove dejavu font from doc build

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Monday, October 26, 2015 2:25 PM
> To: Mcnamara, John
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: remove dejavu font from doc build
> 
> 2015-10-20 12:32, John McNamara:
> > Remove requirement for occasionally hard to find/install
> > DejaVuSansMono font. It isn't gnerally required anyway.
> > The default mono font is sufficient.
> 
> Does it remove the need for texlive-collection-fontsextra?

Hi Thomas,

Possibly. I'll need to test to make sure. I'll let you know.

John.
-- 

Re: [dpdk-dev] [PATCH] doc: remove dejavu font from doc build

[Thomas Monjalon]

2015-10-29 11:35, Mcnamara, John:
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > 2015-10-20 12:32, John McNamara:
> > > Remove requirement for occasionally hard to find/install
> > > DejaVuSansMono font. It isn't gnerally required anyway.
> > > The default mono font is sufficient.
> > 
> > Does it remove the need for texlive-collection-fontsextra?
> 
> Hi,
> 
> I checked and it does remove the requirement for texlive-fonts-recommended in Ubuntu and texlive-collection-fontsextra in Fedora.
> 
> I'll submit a v2 with those requirements removed from the Documentation Guidelines.

Please remove it from the RPM packaging script also.
Thanks

[dpdk-dev] [PATCH v2] doc: remove dejavu font from doc build

[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>
---
 doc/guides/conf.py                        |  1 -
 doc/guides/contributing/documentation.rst | 20 ++++++++------------
 pkg/dpdk.spec                             |  2 +-
 3 files changed, 9 insertions(+), 14 deletions(-)

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index b2290b4..4a4fad2 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -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}
diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
index 7f5f061..6b8a5c6 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -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
diff --git a/pkg/dpdk.spec b/pkg/dpdk.spec
index acbb2be..2d27d40 100644
--- a/pkg/dpdk.spec
+++ b/pkg/dpdk.spec
@@ -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.
-- 
1.8.1.4

Re: [dpdk-dev] [PATCH v2] doc: remove dejavu font from doc build

[Thomas Monjalon]

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)

Re: [dpdk-dev] [PATCH v2] doc: remove dejavu font from doc build

[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.

John.
-- 

Re: [dpdk-dev] [PATCH v2] doc: remove dejavu font from doc build

[Thomas Monjalon]

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.

Re: [dpdk-dev] [PATCH v2] doc: remove dejavu font from doc build

[Mcnamara, John]

> -----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.

[dpdk-dev] [PATCH v3] doc: remove dejavu font from doc build

[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>
---
 doc/guides/conf.py                        |  1 -
 doc/guides/contributing/documentation.rst | 20 ++++++++------------
 pkg/dpdk.spec                             |  2 +-
 3 files changed, 9 insertions(+), 14 deletions(-)

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index b2290b4..4a4fad2 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -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}
diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
index 7f5f061..6dfaaa8 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -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 (at least TexLive-core and the extra Latex support).
 
 * 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
diff --git a/pkg/dpdk.spec b/pkg/dpdk.spec
index acbb2be..2d27d40 100644
--- a/pkg/dpdk.spec
+++ b/pkg/dpdk.spec
@@ -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.
-- 
1.8.1.4

Re: [dpdk-dev] [PATCH v3] doc: remove dejavu font from doc build

[Thomas Monjalon]

2015-11-01 20:17, 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>

Applied, thanks