{"id":209,"url":"https://patchwork.libcamera.org/api/patches/209/?format=json","web_url":"https://patchwork.libcamera.org/patch/209/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/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":"<20190111143824.7778-1-laurent.pinchart@ideasonboard.com>","date":"2019-01-11T14:38:24","name":"[libcamera-devel] Documentation: Add placeholder for Doxygen-generated API documentation","commit_ref":"e42683b40d657eda998e62ef0895a4e386165023","pull_url":null,"state":"accepted","archived":false,"hash":"ddce8ed26059c91110440795ca735f958a4f8794","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/209/mbox/","series":[{"id":70,"url":"https://patchwork.libcamera.org/api/series/70/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=70","date":"2019-01-11T14:38:24","name":"[libcamera-devel] Documentation: Add placeholder for Doxygen-generated API documentation","version":1,"mbox":"https://patchwork.libcamera.org/series/70/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/209/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/209/checks/","tags":{},"headers":{"Return-Path":"","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 5548960B31\n\tfor ;\n\tFri, 11 Jan 2019 15:38:29 +0100 (CET)","from pendragon.bb.dnainternet.fi\n\t(dfj612yyyyyyyyyyyyyby-3.rev.dnainternet.fi\n\t[IPv6:2001:14ba:21f5:5b00::2])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id B9B3C53E\n\tfor ;\n\tFri, 11 Jan 2019 15:38:25 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1547217505;\n\tbh=FrTVzHeLMamfv2LCItSRpNNYd+N4ypzFd9omoQaiuik=;\n\th=From:To:Subject:Date:From;\n\tb=sYHOF6OV04Che9ASr3g2dtjoxFRCGCvKgyYK/u0xwR37oW/BhCAqOJxkQv5Y+r967\n\tpeJNSJEUHqtvMTZPCNEKJ7ePMoJFjeXxJta2y18S63dYncSXJ5JduxRd/91cCSO6FC\n\tnG16WW/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","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH] Documentation: Add placeholder for\n\tDoxygen-generated API documentation","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Fri, 11 Jan 2019 14:38:29 -0000"},"content":"Until we have better Sphinx + Doxygen integration, replace the relative\nexternal link to the API documentation with a placeholder directory,\nwhich will be populated with the Doxygen-generated doc when exporting\ndocumentation to the website. This is needed as the Sphinx documentation\nis exported to the root of the website, linking to ../api-html is thus\nnot possible.\n\nSigned-off-by: Laurent Pinchart \n---\n Documentation/api-html/index.rst | 4 ++++\n Documentation/index.rst | 2 +-\n 2 files changed, 5 insertions(+), 1 deletion(-)\n create mode 100644 Documentation/api-html/index.rst","diff":"diff --git a/Documentation/api-html/index.rst b/Documentation/api-html/index.rst\nnew file mode 100644\nindex 000000000000..dbaaad1552b6\n--- /dev/null\n+++ b/Documentation/api-html/index.rst\n@@ -0,0 +1,4 @@\n+API\n+===\n+\n+:: Placeholder for Doxygen documentation\ndiff --git a/Documentation/index.rst b/Documentation/index.rst\nindex a87509c24275..e481f081f9a1 100644\n--- a/Documentation/index.rst\n+++ b/Documentation/index.rst\n@@ -24,4 +24,4 @@ systems, including traditional Linux distributions, ChromeOS and Android.\n Docs \n Coding Style \n Contribute \n- API <../api-html/index.html#://>\n+ API \n","prefixes":["libcamera-devel"]}