[0/7] Documentation improvements
mbox series

Message ID 20240809145304.537551-1-dan.scally@ideasonboard.com
Headers show
Series
  • Documentation improvements
Related show

Message

Dan Scally Aug. 9, 2024, 2:52 p.m. UTC 
Hi All

This series aims to improve the Documentation .rst files within libcamera so we
can integrate them more easily into the libcamera website. The goal is to add a
structure that can replace the sidebar on the Docs page [1] with links to all of
the Documentation pages within the libcamera tree, especially the guides. To do
this properly some tidying up and reformating of the existing Documentation is
done and the introductory content from guides/introduction.rst moved to the
docs.rst page (and expanded) - this allows us to have the docs page on the
website and the index page in Documentation built within the libcamera tree
display the same content and links.

Thanks
Dan

[1] https://libcamera.org/docs.html

Daniel Scally (7):
  Documentation: Add documentation-contents.rst
  Documentation: Alphabetise the Documentation toctree
  Documentation: Synchronise libcamera architecture details
  Documentation: Breakout docs.rst
  Documentation: Remove camera stack from introduction.rst
  Documentation: Expand introductory content on docs.rst
  Documentation: Rework index.rst

 Documentation/c55.svg                         | 175 ++++++
 Documentation/camera-sensor-model.rst         |   2 +
 Documentation/camera_stack.rst                | 109 ++++
 Documentation/code-of-conduct.rst             |   2 +
 Documentation/coding-style.rst                |   2 +
 Documentation/conf.py                         |   7 +-
 Documentation/docs.rst                        | 544 ++++++++----------
 Documentation/documentation-contents.rst      |  21 +
 Documentation/environment_variables.rst       |   2 +
 Documentation/feature_requirements.rst        | 145 +++++
 Documentation/getting-started.rst             |   1 +
 .../guides/application-developer.rst          |   2 +
 Documentation/guides/introduction.rst         | 319 ----------
 Documentation/guides/ipa.rst                  |   2 +
 Documentation/guides/pipeline-handler.rst     |   2 +
 Documentation/guides/tracing.rst              |   2 +
 Documentation/index.rst                       |  23 +-
 Documentation/lens_driver_requirements.rst    |   2 +
 Documentation/python-bindings.rst             |   2 +
 Documentation/sensor_driver_requirements.rst  |   2 +
 Documentation/software-isp-benchmarking.rst   |   2 +
 Documentation/theme/static/css/theme.css      |   6 +-
 22 files changed, 729 insertions(+), 645 deletions(-)
 create mode 100644 Documentation/c55.svg
 create mode 100644 Documentation/camera_stack.rst
 create mode 100644 Documentation/documentation-contents.rst
 create mode 100644 Documentation/feature_requirements.rst
 delete mode 100644 Documentation/guides/introduction.rst