[PATCH v3 0/7] Documentation improvements
Daniel Scally
dan.scally at ideasonboard.com
Mon Aug 19 18:09:14 CEST 2024
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 camera stack details
Documentation: Breakout docs.rst
Documentation: Remove libcamera architecture from introduction.rst
Documentation: Rework docs.rst into introduction.rst
Documentation: Rework index.rst
Documentation/camera-sensor-model.rst | 2 +
Documentation/code-of-conduct.rst | 2 +
Documentation/coding-style.rst | 2 +
Documentation/conf.py | 10 +-
Documentation/docs.rst | 400 ------------------
Documentation/documentation-contents.rst | 28 ++
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 | 24 +-
Documentation/introduction.rst | 226 ++++++++++
Documentation/lens_driver_requirements.rst | 2 +
Documentation/libcamera_architecture.rst | 155 +++++++
Documentation/mali-c55.dot | 23 +
Documentation/meson.build | 7 +-
Documentation/python-bindings.rst | 2 +
Documentation/sensor_driver_requirements.rst | 2 +
Documentation/software-isp-benchmarking.rst | 2 +
Documentation/theme/static/css/theme.css | 6 +-
README.rst | 3 -
25 files changed, 634 insertions(+), 737 deletions(-)
delete mode 100644 Documentation/docs.rst
create mode 100644 Documentation/documentation-contents.rst
create mode 100644 Documentation/feature_requirements.rst
delete mode 100644 Documentation/guides/introduction.rst
create mode 100644 Documentation/introduction.rst
create mode 100644 Documentation/libcamera_architecture.rst
create mode 100644 Documentation/mali-c55.dot
--
2.34.1
More information about the libcamera-devel
mailing list