{"id":2201,"url":"https://patchwork.libcamera.org/api/1.1/patches/2201/?format=json","web_url":"https://patchwork.libcamera.org/patch/2201/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20191021102453.26471-3-laurent.pinchart@ideasonboard.com>","date":"2019-10-21T10:24:48","name":"[libcamera-devel,3/8] Documentation: Link to API section in Docs","commit_ref":"dd84815d61fe8c306ac799985ae9f2683741c49a","pull_url":null,"state":"accepted","archived":false,"hash":"86cf96fd27315eaa2b070ff8982012ed8f355815","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/1.1/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/2201/mbox/","series":[{"id":539,"url":"https://patchwork.libcamera.org/api/1.1/series/539/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=539","date":"2019-10-21T10:24:46","name":"[libcamera-devel,1/8] Documentation: Move coding style under contributing","version":1,"mbox":"https://patchwork.libcamera.org/series/539/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/2201/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/2201/checks/","tags":{},"headers":{"Return-Path":"<laurent.pinchart@ideasonboard.com>","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id E182E6137A\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 21 Oct 2019 12:25:05 +0200 (CEST)","from pendragon.ideasonboard.com (143.121.2.93.rev.sfr.net\n\t[93.2.121.143])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 4D5A64F7\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 21 Oct 2019 12:25:05 +0200 (CEST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1571653505;\n\tbh=XkffmpYxTwv0f8xQb2jxWK9GLzMF+UkKR9znRV5JjI4=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=XsbbN6WM6M+egLJRr2d2o1iimNZD47TUMTON4jhnqbKfu5Ba8i7pvd13pA5AZl6aM\n\tRSX5N9SP51zzfHmRA/dkvRYeEBI20jO7/M4doOBqKaJHqOB2OYtPgx/0pfgmgKpA1O\n\tlEsm5TONJ8TJm9cynq1Bm0sjkoUKfsEA0rPIFAtY=","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","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","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH 3/8] Documentation: Link to API section in\n\tDocs","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","X-List-Received-Date":"Mon, 21 Oct 2019 10:25:06 -0000"},"content":"The API belongs to the docs section. Link to it from docs.rst, and\nremove the shortcut in the navigation bar as links to a placeholder\nonly.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n Documentation/api-html/index.rst |  2 ++\n Documentation/docs.rst           | 12 ++++++++++++\n Documentation/index.rst          |  1 -\n 3 files changed, 14 insertions(+), 1 deletion(-)","diff":"diff --git a/Documentation/api-html/index.rst b/Documentation/api-html/index.rst\nindex dbaaad1552b6..cf2ef0bb38af 100644\n--- a/Documentation/api-html/index.rst\n+++ b/Documentation/api-html/index.rst\n@@ -1,3 +1,5 @@\n+.. _api:\n+\n API\n ===\n \ndiff --git a/Documentation/docs.rst b/Documentation/docs.rst\nindex cc621a49f412..7a3977c13110 100644\n--- a/Documentation/docs.rst\n+++ b/Documentation/docs.rst\n@@ -2,6 +2,18 @@\n Documentation\n *************\n \n+.. toctree::\n+   :hidden:\n+\n+   API <api-html/index>\n+\n+API\n+===\n+\n+The libcamera API is extensively documented using Doxygen. The :ref:`API\n+nightly build <api>` contains the most up-to-date API documentation, built from\n+the latest master branch.\n+\n Feature Requirements\n ====================\n \ndiff --git a/Documentation/index.rst b/Documentation/index.rst\nindex 84d5f6a88caf..bbce717edd0e 100644\n--- a/Documentation/index.rst\n+++ b/Documentation/index.rst\n@@ -8,4 +8,3 @@\n    Home <self>\n    Docs <docs>\n    Contribute <contributing>\n-   API <api-html/index>\n","prefixes":["libcamera-devel","3/8"]}