[libcamera-devel,0/3] Generate libcamera.org website from documentation
mbox series

Message ID 20190110233829.9638-1-laurent.pinchart@ideasonboard.com
Headers show
Series
  • Generate libcamera.org website from documentation
Related show

Message

Laurent Pinchart Jan. 10, 2019, 11:38 p.m. UTC
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