From patchwork Wed Aug 14 08:41:01 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stefan Klug X-Patchwork-Id: 20907 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 083A6BDB13 for ; Wed, 14 Aug 2024 08:42:26 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id DE18061946; Wed, 14 Aug 2024 10:42:24 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="CTpTHBut"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 15DB161946 for ; Wed, 14 Aug 2024 10:42:23 +0200 (CEST) Received: from ideasonboard.com (unknown [IPv6:2a00:6020:448c:6c00:8a6:aa2:ebee:5ae5]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 49DD62E0; Wed, 14 Aug 2024 10:41:25 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1723624885; bh=J0I9inYe2P+VWp7xtwcg63YxlYcQI5eoeukqikJ4t70=; h=From:To:Cc:Subject:Date:From; b=CTpTHButgaZBst4dgTmIewfSvsstBug3UH3C86uKBMz3xi/23MKMLlbZX0cr/dLiY 8+O6F+wUkaLSMFibRMr/dvUyajOjIbV2k7tBdlXFDhWg2FgSMwOkpMrM/vwkaGdZP9 AOnQXNweoU5OlMWbU6pa40/W2LyS8igv4+LSLY70= From: Stefan Klug To: libcamera-devel@lists.libcamera.org Cc: Stefan Klug Subject: [RFC v1 0/2] Documentation: include tuning-guide via external repo Date: Wed, 14 Aug 2024 10:41:01 +0200 Message-ID: <20240814084215.61857-1-stefan.klug@ideasonboard.com> X-Mailer: git-send-email 2.43.0 MIME-Version: 1.0 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: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" Hi everyone, These patches contain two documentation aspects I'd like to propose/discuss. Patch 1 switches the html docs to the furo theme. Reasoning is in the commit message. I don't know all the places where the output of our documentation gets used. So maybe I'm underestimating the implications of that. A preview of the result is available here: https://libcamera.stefanklug.com/ Patch 2 incorporates the tuning guide using an external repo. The reasoning is again in the commit message. The name of that new repo is still tbd. I'd propose: https://gitlab.freedesktop.org/camera/libcamera-sensor-tuning-guide or https://gitlab.freedesktop.org/camera/libcamera-gudes-sensor-tuning if we believe there will be more guides coming up. Best regards, Stefan Stefan Klug (2): Documentation: Use the furo sphinx theme Documentation: Add tuning guide from external source Documentation/conf.py | 21 +- Documentation/guides/tuning | 1 + Documentation/index.rst | 1 + Documentation/meson.build | 2 + Documentation/theme/footer.html | 14 - Documentation/theme/layout.html | 109 ------- Documentation/theme/search.html | 63 ---- Documentation/theme/static/css/theme.css | 291 ------------------- Documentation/theme/static/logo-and-text.svg | 223 ++++++++++++++ Documentation/theme/static/search.png | Bin 482 -> 0 bytes Documentation/theme/theme.conf | 7 - README.rst | 2 +- subprojects/libcamera-tuning-guide.wrap | 7 + 13 files changed, 251 insertions(+), 490 deletions(-) create mode 120000 Documentation/guides/tuning delete mode 100644 Documentation/theme/footer.html delete mode 100644 Documentation/theme/layout.html delete mode 100644 Documentation/theme/search.html delete mode 100644 Documentation/theme/static/css/theme.css create mode 100644 Documentation/theme/static/logo-and-text.svg delete mode 100644 Documentation/theme/static/search.png delete mode 100644 Documentation/theme/theme.conf create mode 100644 subprojects/libcamera-tuning-guide.wrap