From patchwork Thu Jan 10 23:38:26 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 194 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id BDB8160B0F for ; Fri, 11 Jan 2019 00:38:33 +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 35D4F56D for ; Fri, 11 Jan 2019 00:38:32 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1547163512; bh=i34TAerUfBAOiZzImQCCiTonc/VI2j4ICous8HaEIT8=; h=From:To:Subject:Date:From; b=FAX5zWi3cfXdOh9i7ZXGZXpuKQv79F7nlYUgyihWY879f+P6wwb+s3P3HoiBCYbK+ KtxIzDEibmNdO4coSIua6VnUVAy3KaQeLGAcq/qcNVbmupj3d3Dk73/eJFIs/kpulI fhZgSza5tpn6yvFQpNFRA/ZsCzhy5f7p+ShIb1CY= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Date: Fri, 11 Jan 2019 01:38:26 +0200 Message-Id: <20190110233829.9638-1-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.19.2 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 0/3] Generate libcamera.org website from 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: Thu, 10 Jan 2019 23:38:34 -0000 Hello, This patch series adds a custom Sphinx theme to output documentation with the same look & feel as the existing libcamera website. The existing content is preserved, but the index page doesn't replicate the look of the website. There are a few hacks here in there, in particular in the last patch, or in how the toc tree from the index page is hidden using css. On the plus side we now have a search box :-) I believe we will need to move the sphinx-generated documentation to a subsection of the website at some point down the road, and use a different generator that will allow more dynamic content (such as blogging for instance). That being said, I think this patch series is an improvement overall. Laurent Pinchart (3): Documentation: Add custom theme Documentation: Make the toctree more web-friendly Documentation: Link to the API documentation generated by Doxygen Documentation/conf.py | 3 +- Documentation/index.rst | 15 +- Documentation/theme/footer.html | 11 + Documentation/theme/layout.html | 116 ++++++++++ Documentation/theme/search.html | 60 +++++ Documentation/theme/static/css/theme.css | 274 +++++++++++++++++++++++ Documentation/theme/static/search.png | Bin 0 -> 482 bytes Documentation/theme/theme.conf | 5 + 8 files changed, 473 insertions(+), 11 deletions(-) create mode 100644 Documentation/theme/footer.html create mode 100644 Documentation/theme/layout.html create mode 100644 Documentation/theme/search.html create mode 100644 Documentation/theme/static/css/theme.css create mode 100644 Documentation/theme/static/search.png create mode 100644 Documentation/theme/theme.conf