[RFC,v1,0/2] Documentation: include tuning-guide via external repo
mbox series

Message ID 20240814084215.61857-1-stefan.klug@ideasonboard.com
Headers show
Series
  • Documentation: include tuning-guide via external repo
Related show

Message

Stefan Klug Aug. 14, 2024, 8:41 a.m. UTC 
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