* [dpdk-dev] [PATCH] doc: cleanup doc index files
@ 2015-12-15 10:10 John McNamara
2015-12-15 10:36 ` Van Haaren, Harry
0 siblings, 1 reply; 3+ messages in thread
From: John McNamara @ 2015-12-15 10:10 UTC (permalink / raw)
To: dev
Remove **Contents** and |Today| from the rst doc index files since
these are already added automatically to PDF files and are of
little value to the Html files where the Contents is shown in a
sidebar.
Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
doc/guides/faq/index.rst | 2 --
doc/guides/freebsd_gsg/index.rst | 4 ----
doc/guides/index.rst | 2 --
doc/guides/linux_gsg/index.rst | 4 ----
doc/guides/nics/index.rst | 5 -----
doc/guides/prog_guide/index.rst | 5 -----
doc/guides/rel_notes/index.rst | 4 ----
doc/guides/sample_app_ug/index.rst | 4 ----
doc/guides/testpmd_app_ug/index.rst | 4 ----
doc/guides/xen/index.rst | 4 ----
10 files changed, 38 deletions(-)
diff --git a/doc/guides/faq/index.rst b/doc/guides/faq/index.rst
index 5bc84ac..6ca659f 100644
--- a/doc/guides/faq/index.rst
+++ b/doc/guides/faq/index.rst
@@ -33,8 +33,6 @@ DPDK FAQ
This document contains some Frequently Asked Questions that arise when working with DPDK.
-Contents
-
.. toctree::
:maxdepth: 2
:numbered:
diff --git a/doc/guides/freebsd_gsg/index.rst b/doc/guides/freebsd_gsg/index.rst
index 37e4cc1..3729f16 100644
--- a/doc/guides/freebsd_gsg/index.rst
+++ b/doc/guides/freebsd_gsg/index.rst
@@ -33,10 +33,6 @@
Getting Started Guide for FreeBSD
=================================
-|today|
-
-**Contents**
-
.. toctree::
:maxdepth: 2
:numbered:
diff --git a/doc/guides/index.rst b/doc/guides/index.rst
index c5d7a9f..638eab9 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/index.rst
@@ -31,8 +31,6 @@
DPDK documentation
==================
-Contents:
-
.. toctree::
:maxdepth: 1
:titlesonly:
diff --git a/doc/guides/linux_gsg/index.rst b/doc/guides/linux_gsg/index.rst
index d68135b..3d3ada1 100644
--- a/doc/guides/linux_gsg/index.rst
+++ b/doc/guides/linux_gsg/index.rst
@@ -33,10 +33,6 @@
Getting Started Guide for Linux
===============================
-|today|
-
-Contents
-
.. toctree::
:maxdepth: 2
:numbered:
diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
index 2f7506c..33c9cea 100644
--- a/doc/guides/nics/index.rst
+++ b/doc/guides/nics/index.rst
@@ -31,11 +31,6 @@
Network Interface Controller Drivers
====================================
-|today|
-
-
-**Contents**
-
.. toctree::
:maxdepth: 3
:numbered:
diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst
index 176f2c2..9359f2e 100644
--- a/doc/guides/prog_guide/index.rst
+++ b/doc/guides/prog_guide/index.rst
@@ -31,11 +31,6 @@
Programmer's Guide
==================
-|today|
-
-
-**Contents**
-
.. toctree::
:maxdepth: 3
:numbered:
diff --git a/doc/guides/rel_notes/index.rst b/doc/guides/rel_notes/index.rst
index d8cadeb..5c1c8c6 100644
--- a/doc/guides/rel_notes/index.rst
+++ b/doc/guides/rel_notes/index.rst
@@ -31,10 +31,6 @@
DPDK Release Notes
==================
-|today|
-
-Contents
-
.. toctree::
:maxdepth: 1
:numbered:
diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst
index becd682..8a646dd 100644
--- a/doc/guides/sample_app_ug/index.rst
+++ b/doc/guides/sample_app_ug/index.rst
@@ -31,10 +31,6 @@
Sample Applications User Guide
==============================
-|today|
-
-**Contents**
-
.. toctree::
:maxdepth: 2
:numbered:
diff --git a/doc/guides/testpmd_app_ug/index.rst b/doc/guides/testpmd_app_ug/index.rst
index 3b163c1..1c39a17 100644
--- a/doc/guides/testpmd_app_ug/index.rst
+++ b/doc/guides/testpmd_app_ug/index.rst
@@ -31,10 +31,6 @@
Testpmd Application User Guide
==============================
-|today|
-
-**Contents**
-
.. toctree::
:maxdepth: 3
:numbered:
diff --git a/doc/guides/xen/index.rst b/doc/guides/xen/index.rst
index 628ecc3..cb43cd2 100644
--- a/doc/guides/xen/index.rst
+++ b/doc/guides/xen/index.rst
@@ -31,10 +31,6 @@
Xen Guide
=========
-|today|
-
-**Contents**
-
.. toctree::
:maxdepth: 2
:numbered:
--
2.5.0
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [dpdk-dev] [PATCH] doc: cleanup doc index files
2015-12-15 10:10 [dpdk-dev] [PATCH] doc: cleanup doc index files John McNamara
@ 2015-12-15 10:36 ` Van Haaren, Harry
2015-12-15 10:44 ` Thomas Monjalon
0 siblings, 1 reply; 3+ messages in thread
From: Van Haaren, Harry @ 2015-12-15 10:36 UTC (permalink / raw)
To: Mcnamara, John, dev
> Subject: [dpdk-dev] [PATCH] doc: cleanup doc index files
>
> Remove **Contents** and |Today| from the rst doc index files since
> these are already added automatically to PDF files and are of
> little value to the Html files where the Contents is shown in a
> sidebar.
>
> Signed-off-by: John McNamara <john.mcnamara@intel.com>
> ---
> doc/guides/faq/index.rst | 2 --
> doc/guides/freebsd_gsg/index.rst | 4 ----
> doc/guides/index.rst | 2 --
> doc/guides/linux_gsg/index.rst | 4 ----
> doc/guides/nics/index.rst | 5 -----
> doc/guides/prog_guide/index.rst | 5 -----
> doc/guides/rel_notes/index.rst | 4 ----
> doc/guides/sample_app_ug/index.rst | 4 ----
> doc/guides/testpmd_app_ug/index.rst | 4 ----
> doc/guides/xen/index.rst | 4 ----
> 10 files changed, 38 deletions(-)
Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [dpdk-dev] [PATCH] doc: cleanup doc index files
2015-12-15 10:36 ` Van Haaren, Harry
@ 2015-12-15 10:44 ` Thomas Monjalon
0 siblings, 0 replies; 3+ messages in thread
From: Thomas Monjalon @ 2015-12-15 10:44 UTC (permalink / raw)
To: Mcnamara, John; +Cc: dev
2015-12-15 10:36, Van Haaren, Harry:
> > Subject: [dpdk-dev] [PATCH] doc: cleanup doc index files
> >
> > Remove **Contents** and |Today| from the rst doc index files since
> > these are already added automatically to PDF files and are of
> > little value to the Html files where the Contents is shown in a
> > sidebar.
> >
> > Signed-off-by: John McNamara <john.mcnamara@intel.com>
>
> Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
Applied, thanks
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2015-12-15 10:46 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-12-15 10:10 [dpdk-dev] [PATCH] doc: cleanup doc index files John McNamara
2015-12-15 10:36 ` Van Haaren, Harry
2015-12-15 10:44 ` Thomas Monjalon
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).