[libcamera-devel] [PATCH v5 1/4] Documentation: Add python-bindings.rst

[Tomi Valkeinen]

On 08/06/2022 16:39, Laurent Pinchart wrote:
> Hi Tomi,
> 
> On Wed, Jun 08, 2022 at 10:24:15AM +0300, Tomi Valkeinen wrote:
>> Add a basic doc for the Python bindings. While not really proper
>> documentation yet, the file and the examples should give enough guidance
>> for users who are somewhat familiar with libcamera.
>>
>> Signed-off-by: Tomi Valkeinen <tomi.valkeinen at ideasonboard.com>
>> Reviewed-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
>> ---
>>   Documentation/index.rst           |  1 +
>>   Documentation/meson.build         |  1 +
>>   Documentation/python-bindings.rst | 69 +++++++++++++++++++++++++++++++
>>   3 files changed, 71 insertions(+)
>>   create mode 100644 Documentation/python-bindings.rst
>>
>> diff --git a/Documentation/index.rst b/Documentation/index.rst
>> index 0ee10044..43d8b017 100644
>> --- a/Documentation/index.rst
>> +++ b/Documentation/index.rst
>> @@ -22,3 +22,4 @@
>>      Environment variables <environment_variables>
>>      Sensor driver requirements <sensor_driver_requirements>
>>      Lens driver requirements <lens_driver_requirements>
>> +   Python Bindings <python-bindings>
>> diff --git a/Documentation/meson.build b/Documentation/meson.build
>> index 8e2eacc6..7695bcb1 100644
>> --- a/Documentation/meson.build
>> +++ b/Documentation/meson.build
>> @@ -67,6 +67,7 @@ if sphinx.found()
>>           'guides/tracing.rst',
>>           'index.rst',
>>           'lens_driver_requirements.rst',
>> +        'python-bindings.rst',
>>           'sensor_driver_requirements.rst',
>>          '../README.rst',
>>       ]
>> diff --git a/Documentation/python-bindings.rst b/Documentation/python-bindings.rst
>> new file mode 100644
>> index 00000000..d59935ae
>> --- /dev/null
>> +++ b/Documentation/python-bindings.rst
>> @@ -0,0 +1,69 @@
>> +.. SPDX-License-Identifier: CC-BY-SA-4.0
>> +
>> +.. _python-bindings:
>> +
>> +Python Bindings for libcamera
>> +=============================
>> +
>> +*WARNING* The bindings are under work, and the API will change.
> 
> Can I change this to
> 
> .. warning:
>      The bindings are under work, and the API will change.
> 
> ? I'll then push the patch.

Sure. Thanks!

  Tomi