* [dts] [PATCH v1] doc: use the rtd theme for the dts docs
@ 2017-06-23 12:44 John McNamara
2017-06-24 1:20 ` Liu, Yong
0 siblings, 1 reply; 2+ messages in thread
From: John McNamara @ 2017-06-23 12:44 UTC (permalink / raw)
To: dts; +Cc: yong.liu, John McNamara
Use the dpdk.org style ReadTheDocs theme for the DTS user docs,
when available.
Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
doc/dts_gsg/conf.py | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/doc/dts_gsg/conf.py b/doc/dts_gsg/conf.py
index 6a8c679..568150e 100644
--- a/doc/dts_gsg/conf.py
+++ b/doc/dts_gsg/conf.py
@@ -1,5 +1,5 @@
# BSD LICENSE
-# Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
+# Copyright(c) 2010-2017 Intel Corporation. All rights reserved.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
@@ -28,13 +28,14 @@
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-import subprocess
+try:
+ import sphinx_rtd_theme
-project = 'DPDK Test Suite'
-
-copyright = '2015, dpdk.org'
-
-#version = subprocess.check_output(["make","-sRrC","../../", "showversion"])
+ html_theme = "sphinx_rtd_theme"
+ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+except:
+ pass
+project = 'DPDK Test Suite'
+copyright = '2017, dpdk.org'
master_doc = 'index'
-
--
2.7.4
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [dts] [PATCH v1] doc: use the rtd theme for the dts docs
2017-06-23 12:44 [dts] [PATCH v1] doc: use the rtd theme for the dts docs John McNamara
@ 2017-06-24 1:20 ` Liu, Yong
0 siblings, 0 replies; 2+ messages in thread
From: Liu, Yong @ 2017-06-24 1:20 UTC (permalink / raw)
To: John McNamara, dts
Thanks, John. Merged into master branch.
On 06/23/2017 08:44 PM, John McNamara wrote:
> Use the dpdk.org style ReadTheDocs theme for the DTS user docs,
> when available.
>
> Signed-off-by: John McNamara <john.mcnamara@intel.com>
> ---
> doc/dts_gsg/conf.py | 17 +++++++++--------
> 1 file changed, 9 insertions(+), 8 deletions(-)
>
> diff --git a/doc/dts_gsg/conf.py b/doc/dts_gsg/conf.py
> index 6a8c679..568150e 100644
> --- a/doc/dts_gsg/conf.py
> +++ b/doc/dts_gsg/conf.py
> @@ -1,5 +1,5 @@
> # BSD LICENSE
> -# Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
> +# Copyright(c) 2010-2017 Intel Corporation. All rights reserved.
> # All rights reserved.
> #
> # Redistribution and use in source and binary forms, with or without
> @@ -28,13 +28,14 @@
> # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
> # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
>
> -import subprocess
> +try:
> + import sphinx_rtd_theme
>
> -project = 'DPDK Test Suite'
> -
> -copyright = '2015, dpdk.org'
> -
> -#version = subprocess.check_output(["make","-sRrC","../../", "showversion"])
> + html_theme = "sphinx_rtd_theme"
> + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
> +except:
> + pass
>
> +project = 'DPDK Test Suite'
> +copyright = '2017, dpdk.org'
> master_doc = 'index'
> -
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2017-06-23 16:33 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-06-23 12:44 [dts] [PATCH v1] doc: use the rtd theme for the dts docs John McNamara
2017-06-24 1:20 ` Liu, Yong
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).