From patchwork Fri Jan 11 14:38:24 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 209 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 5548960B31 for ; Fri, 11 Jan 2019 15:38:29 +0100 (CET) Received: from pendragon.bb.dnainternet.fi (dfj612yyyyyyyyyyyyyby-3.rev.dnainternet.fi [IPv6:2001:14ba:21f5:5b00::2]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id B9B3C53E for ; Fri, 11 Jan 2019 15:38:25 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1547217505; bh=FrTVzHeLMamfv2LCItSRpNNYd+N4ypzFd9omoQaiuik=; h=From:To:Subject:Date:From; b=sYHOF6OV04Che9ASr3g2dtjoxFRCGCvKgyYK/u0xwR37oW/BhCAqOJxkQv5Y+r967 peJNSJEUHqtvMTZPCNEKJ7ePMoJFjeXxJta2y18S63dYncSXJ5JduxRd/91cCSO6FC nG16WW/YFvv9vng9DoBT1Qhr1NnJqYApdh0YjGEw= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Date: Fri, 11 Jan 2019 16:38:24 +0200 Message-Id: <20190111143824.7778-1-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.19.2 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH] Documentation: Add placeholder for Doxygen-generated API documentation X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 11 Jan 2019 14:38:29 -0000 Until we have better Sphinx + Doxygen integration, replace the relative external link to the API documentation with a placeholder directory, which will be populated with the Doxygen-generated doc when exporting documentation to the website. This is needed as the Sphinx documentation is exported to the root of the website, linking to ../api-html is thus not possible. Signed-off-by: Laurent Pinchart Acked-by: Kieran Bingham --- Documentation/api-html/index.rst | 4 ++++ Documentation/index.rst | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 Documentation/api-html/index.rst diff --git a/Documentation/api-html/index.rst b/Documentation/api-html/index.rst new file mode 100644 index 000000000000..dbaaad1552b6 --- /dev/null +++ b/Documentation/api-html/index.rst @@ -0,0 +1,4 @@ +API +=== + +:: Placeholder for Doxygen documentation diff --git a/Documentation/index.rst b/Documentation/index.rst index a87509c24275..e481f081f9a1 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -24,4 +24,4 @@ systems, including traditional Linux distributions, ChromeOS and Android. Docs Coding Style Contribute - API <../api-html/index.html#://> + API