From patchwork Mon Oct 21 10:24:48 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 2201 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id E182E6137A for ; Mon, 21 Oct 2019 12:25:05 +0200 (CEST) Received: from pendragon.ideasonboard.com (143.121.2.93.rev.sfr.net [93.2.121.143]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 4D5A64F7 for ; Mon, 21 Oct 2019 12:25:05 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1571653505; bh=XkffmpYxTwv0f8xQb2jxWK9GLzMF+UkKR9znRV5JjI4=; h=From:To:Subject:Date:In-Reply-To:References:From; b=XsbbN6WM6M+egLJRr2d2o1iimNZD47TUMTON4jhnqbKfu5Ba8i7pvd13pA5AZl6aM RSX5N9SP51zzfHmRA/dkvRYeEBI20jO7/M4doOBqKaJHqOB2OYtPgx/0pfgmgKpA1O lEsm5TONJ8TJm9cynq1Bm0sjkoUKfsEA0rPIFAtY= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Date: Mon, 21 Oct 2019 13:24:48 +0300 Message-Id: <20191021102453.26471-3-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.23.0 In-Reply-To: <20191021102453.26471-1-laurent.pinchart@ideasonboard.com> References: <20191021102453.26471-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 3/8] Documentation: Link to API section in Docs X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 21 Oct 2019 10:25:06 -0000 The API belongs to the docs section. Link to it from docs.rst, and remove the shortcut in the navigation bar as links to a placeholder only. Signed-off-by: Laurent Pinchart Reviewed-by: Kieran Bingham --- Documentation/api-html/index.rst | 2 ++ Documentation/docs.rst | 12 ++++++++++++ Documentation/index.rst | 1 - 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/Documentation/api-html/index.rst b/Documentation/api-html/index.rst index dbaaad1552b6..cf2ef0bb38af 100644 --- a/Documentation/api-html/index.rst +++ b/Documentation/api-html/index.rst @@ -1,3 +1,5 @@ +.. _api: + API === diff --git a/Documentation/docs.rst b/Documentation/docs.rst index cc621a49f412..7a3977c13110 100644 --- a/Documentation/docs.rst +++ b/Documentation/docs.rst @@ -2,6 +2,18 @@ Documentation ************* +.. toctree:: + :hidden: + + API + +API +=== + +The libcamera API is extensively documented using Doxygen. The :ref:`API +nightly build ` contains the most up-to-date API documentation, built from +the latest master branch. + Feature Requirements ==================== diff --git a/Documentation/index.rst b/Documentation/index.rst index 84d5f6a88caf..bbce717edd0e 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -8,4 +8,3 @@ Home Docs Contribute - API