From patchwork Wed Aug 24 15:36:16 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Markus Heiser X-Patchwork-Id: 9298015 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 953E6607D0 for ; Wed, 24 Aug 2016 15:37:20 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 86D71290BB for ; Wed, 24 Aug 2016 15:37:20 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 7B49C290DC; Wed, 24 Aug 2016 15:37:20 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id C95DA290BB for ; Wed, 24 Aug 2016 15:37:19 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754248AbcHXPhK (ORCPT ); Wed, 24 Aug 2016 11:37:10 -0400 Received: from smtp1.goneo.de ([85.220.129.30]:41446 "EHLO smtp1.goneo.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1754192AbcHXPhI (ORCPT ); Wed, 24 Aug 2016 11:37:08 -0400 Received: from localhost (localhost [127.0.0.1]) by smtp1.goneo.de (Postfix) with ESMTP id D3EAA240E18; Wed, 24 Aug 2016 17:37:05 +0200 (CEST) X-Virus-Scanned: by goneo Received: from smtp1.goneo.de ([127.0.0.1]) by localhost (smtp1.goneo.de [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id l8K0elAklV6m; Wed, 24 Aug 2016 17:36:30 +0200 (CEST) Received: from ubu1604.fritz.box (dyndsl-095-033-017-022.ewe-ip-backbone.de [95.33.17.22]) by smtp1.goneo.de (Postfix) with ESMTPSA id 6139D2425DB; Wed, 24 Aug 2016 17:36:30 +0200 (CEST) From: Markus Heiser To: Mauro Carvalho Chehab Cc: Markus Heiser , Jonathan Corbet , Jani Nikula , Linux Media Mailing List Subject: [PATCH 3/3] doc-rst:media: build separated PDF books (experimental) Date: Wed, 24 Aug 2016 17:36:16 +0200 Message-Id: <1472052976-22541-4-git-send-email-markus.heiser@darmarit.de> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1472052976-22541-1-git-send-email-markus.heiser@darmarit.de> References: <1472052976-22541-1-git-send-email-markus.heiser@darmarit.de> Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: Markus Heiser This patch is only to demonstrate, how to build separated PDF books of the media sub-folder and close open links with intersphinx. It is an experimental state (I detected an build error, which I have not yet traced deep). Builds PDFs of: * media_uapi.pdf: Linux Media Infrastructure userspace API * media_kapi.pdf: Media subsystem kernel internal API * dvb_drivers.pdf: Linux Digital TV driver-specific documentation * v4l_drivers.pdf: Video4Linux (V4L) driver-specific documentation It uses the intersphinx extension to close links which refer to content outside of the (small) pdf-book. The intersphinx links refer to the documentation served at url: https://www.linuxtv.org/downloads/v4l-dvb-apis-new/ E.g.: on page 154 of the media_kapi.pdf in paragraph """YUV Formats lists existing packed ...""" the 'YUV Formats' text refer to url: https://www.linuxtv.org/downloads/v4l-dvb-apis-new/media/uapi/v4l/subdev-formats.html#v4l2-mbus-pixelcode-yuv8 This is only a small example to illustrate how we can build small books and link them with intersphinx. Signed-off-by: Markus Heiser --- Documentation/media/conf.py | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/Documentation/media/conf.py b/Documentation/media/conf.py index bef927b..84575de 100644 --- a/Documentation/media/conf.py +++ b/Documentation/media/conf.py @@ -5,6 +5,21 @@ project = 'Linux Media Subsystem Documentation' tags.add("subproject") latex_documents = [ - ('index', 'media.tex', 'Linux Media Subsystem Documentation', + ('media_uapi', 'media_uapi.tex', 'Linux Media Infrastructure userspace API', + 'The kernel development community', 'manual'), + ('media_kapi', 'media_kapi.tex', 'Media subsystem kernel internal API', + 'The kernel development community', 'manual'), + ('dvb-drivers/index', 'dvb_drivers.tex', 'Linux Digital TV driver-specific documentation', + 'The kernel development community', 'manual'), + ('v4l-drivers/index', 'v4l_drivers.tex', 'Video4Linux (V4L) driver-specific documentation', 'The kernel development community', 'manual'), ] + +# Since intersphinx is not activated in the global Documentation/conf.py we +# activate it here. If times comes where it is activated in the global conf.py, +# we may have to drop these two lines. +extensions.append('sphinx.ext.intersphinx') +intersphinx_mapping = {} + +# add intersphinx inventory of the *complete* documentation from linuxtv.org +intersphinx_mapping['media'] = ('https://www.linuxtv.org/downloads/v4l-dvb-apis-new/', None)