[libcamera-devel] [PATCH] Documentation: camera-sensor-model: Support Sphinx < 2.0

Kieran Bingham kieran.bingham at ideasonboard.com
Tue Jan 9 16:38:28 CET 2024


Quoting Jacopo Mondi via libcamera-devel (2024-01-09 15:20:15)
> Hi Laurent
> 
> On Tue, Jan 09, 2024 at 05:10:28PM +0200, Laurent Pinchart wrote:
> > On Tue, Jan 09, 2024 at 04:06:00PM +0100, Jacopo Mondi wrote:
> > > On Tue, Jan 09, 2024 at 04:30:02PM +0200, Laurent Pinchart wrote:
> > > > The language argument to the code-block directive was mandatory in
> > > > Sphinx before 2.0. Fix the few instances where no language is specified
> > > > to support older versions of Sphinx.
> > >
> > > Thanks, good spot
> > >
> > > > Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
> > > > ---
> > > >  Documentation/camera-sensor-model.rst | 25 ++++++++++++-------------
> > > >  1 file changed, 12 insertions(+), 13 deletions(-)
> > > >
> > > > diff --git a/Documentation/camera-sensor-model.rst b/Documentation/camera-sensor-model.rst
> > > > index 58bf70e1dc5a..b66c880a5e00 100644
> > > > --- a/Documentation/camera-sensor-model.rst
> > > > +++ b/Documentation/camera-sensor-model.rst
> > > > @@ -105,35 +105,34 @@ control:
> > > >        will be downscaled in its vertical and horizontal sizes by the specified
> > > >        factor.
> > > >
> > > > -      .. code-block::
> > > > +      .. code-block:: c
> > > >           :caption: Definition: The horizontal and vertical binning factors
> > > >
> > > >           horizontal_binning = xBin;
> > > >           vertical_binning = yBin;
> > > >
> > > > -
> > >
> > > If I'm not mistaken, other code-block sections in this file were followed by 2
> > > empty lines. You are here removing one in this instance, but the other
> > > ones are not changed. Should we take the occasion to align all of them
> > > to use a single empty line ?
> >
> > I'm fine either way. I think Kieran would like to integrate this
> > quickly, so the whitespace cleanups could be done on top, or he can drop
> > the extra lines locally.
> >
> > Kieran, please double-check the compiled documentation for formatting
> > issues, even if it compiles fine with blank lines removed.
> >
> 
> I see no visual differences in the two version and I've not found any
> requirement about multiple empty lines after a code-block in the
> Sphinx documentation

The output looks fine to me.

--
Kieran


More information about the libcamera-devel mailing list