[libcamera-devel] [PATCH] Documentation: quieten sphinx-build output

[Jacopo Mondi]

Hi Kieran,

On Mon, Jan 14, 2019 at 09:40:44AM +0000, Kieran Bingham wrote:
> The output of the sphinx-build for our documentation is overly verbose.
> Reduce this output to warnings and errors with the '-q' quiet option.
>

Thanks, this removes all the following output from my build, but keeps
warning in build step [19/31]. Good!

-------------------------------------------------------------------------------
[19/31] Generating doxygen with a custom command.
/home/jmondi/project/libcamera/libcamera.git/src/libcamera/pipeline/vimc.cpp:17: warning: Compound libcamera::PipeHandlerVimc is not documented.
[31/31] Generating documentation with a custom command.
Running Sphinx v1.8.3
making output directory...
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 5 source files that are out of date
updating environment: 5 added, 0 changed, 0 removed
reading sources... [ 20%] api-html/index
reading sources... [ 40%] coding-style
reading sources... [ 60%] contributing
reading sources... [ 80%] docs
reading sources... [100%] index

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 20%] api-html/index
writing output... [ 40%] coding-style
writing output... [ 60%] contributing
writing output... [ 80%] docs
writing output... [100%] index

generating indices... genindex
writing additional pages... search
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded.

The HTML pages are in Documentation/html.
-------------------------------------------------------------------------------

-------------------------------------------------------------------------------
[19/31] Generating doxygen with a custom command.
/home/jmondi/project/libcamera/libcamera.git/src/libcamera/pipeline/vimc.cpp:17: warning: Compound libcamera::PipeHandlerVimc is not documented.
[31/31] Linking target test/media_device/media_device_test.
-------------------------------------------------------------------------------

Please add
Acked-by: Jacopo Mondi <jacopo at jmondi.org>

Thanks
  j


> Signed-off-by: Kieran Bingham <kieran.bingham at ideasonboard.com>
> ---
>  Documentation/meson.build | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/meson.build b/Documentation/meson.build
> index dd43b2cbd401..73da25b848cc 100644
> --- a/Documentation/meson.build
> +++ b/Documentation/meson.build
> @@ -49,7 +49,7 @@ if sphinx.found()
>      ]
>
>      custom_target('documentation',
> -                  command: [sphinx, '-W', '-b', 'html', meson.current_source_dir(), '@OUTPUT@'],
> +                  command: [sphinx, '-q', '-W', '-b', 'html', meson.current_source_dir(), '@OUTPUT@'],
>                    input: docs_sources,
>                    output: 'html',
>                    build_by_default: true,
> --
> 2.17.1
>
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel at lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <https://lists.libcamera.org/pipermail/libcamera-devel/attachments/20190114/0f027057/attachment.sig>