On Fri, May 28, 2021 at 10:35 AM Michael Opdenacker <
michael.opdenacker@bootlin.com> wrote:

> Hi Quentin,
>
> On 5/27/21 8:31 PM, Quentin Schulz wrote:
> > -W is for turning warnings into errors, --keep-going to make sure the
> > whole documentation is built and all warnings will be printed before
> > failing.
> >
> > Since there's currently no warning, it's time to introduce it!
> >
> > Signed-off-by: Quentin Schulz <foss@0leil.net>
> > ---
> >  documentation/Makefile | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/documentation/Makefile b/documentation/Makefile
> > index d40f390e2..996f01b7d 100644
> > --- a/documentation/Makefile
> > +++ b/documentation/Makefile
> > @@ -3,7 +3,7 @@
> >
> >  # You can set these variables from the command line, and also
> >  # from the environment for the first two.
> > -SPHINXOPTS    ?= -j auto
> > +SPHINXOPTS    ?= -W --keep-going -j auto
> >  SPHINXBUILD   ?= sphinx-build
> >  SOURCEDIR     = .
> >  BUILDDIR      = _build
>
>
> Thanks for the nice improvement. I tested that it builds the "html" and
> "latexpdf" targets just fine, but it aborts with "epub" as follows:
>
> writing mimetype file...
> writing META-INF/container.xml file...
> writing content.opf file...
> WARNING: unknown mimetype for .poky.yaml.cache, ignoring
> writing nav.xhtml file...
> writing toc.ncx file...
> writing TheYoctoProject.epub file...
> build finished with problems, 1 warning.
> make: *** [Makefile:35: epub] Error 1
>
> If I understood correctly, this happens because the .yaml file is not
> understood by Sphinx, as explained on
> https://github.com/sphinx-doc/sphinx/issues/3214. However, I don't
> understand why this only happens with "epub" output.
>

interesting.. I tested it yesterday, and it worked for me... So I tried
again today, and realized i was using Sphinx 3.3.1, I updated to 4.0.2 and
now it fails too..


>
> A workaround is to disable warnings for unknown project files:
>
> diff --git a/documentation/conf.py b/documentation/conf.py
> index 5a2e25f7b2..6c6458fed7 100644
> --- a/documentation/conf.py
> +++ b/documentation/conf.py
> @@ -92,6 +92,9 @@ intersphinx_mapping = {
>      'bitbake': ('https://docs.yoctoproject.org/bitbake/', None)
>  }
>
> +# Suppress "WARNING: unknown mimetype for ..."
> +suppress_warnings = ['epub.unknown_project_files']
> +
>  # -- Options for HTML output
> -------------------------------------------------
>
>  # The theme to use for HTML and HTML Help pages.  See the documentation
> for
>
>
> Would this be acceptable? I hope so, because I believe having your
> changes would be useful.
>
> Cheers,
>
> Michael.
>
> --
> Michael Opdenacker, Bootlin
> Embedded Linux and Kernel engineering
> https://bootlin.com
>
>
> 
>
>