Read the docs is not building anymore about sphinx-gallery HOT 12 CLOSED

Looking at the readthedocs here: https://readthedocs.org/projects/sphinx-gallery/builds/3274914/.

The html build runs fine but then the json build fails. Any idea what the json build is supposed to do?

from sphinx-gallery.

I had a look yesterday. It is more a thing of read the docs that I don't find documentation for. It looks like app.builder.outdir is sometimes html with html files and sometimes json with json files. I retested in my branch and own build.
https://github.com/Titan-C/sphinx-gallery/commits/refactor_split
to get some debugging messages
but when I renamed searchindex.js to searchindex.json. Read the docs restarted to use the html build.
Compare
https://readthedocs.org/projects/sphinx-gallery-local/builds/3278891/
with
https://readthedocs.org/projects/sphinx-gallery-local/builds/3278880/

And the build will crash again.

from sphinx-gallery.

OK I don't know why this is happening, but it looks that readthedocs now builds in two steps:

• first with the 'readthedocs' builder (i.e. -b readthedocs) whatever this is and this step succeeds in your second link.
• then with the 'json' builder (i.e. -b json). Not sure what this is useful for to be honest. This step fails in your second link.

In your first link I am not sure what was your intent of renaming searchindex.js to searchindex.json. The 'readthedocs' step now fails because it is trying to open searchindex.json whereas the sphinx build generated a searchindex.js ...

from sphinx-gallery.

I forgot to say I can reproduce the 'json' builder failure locally by running:

sphinx-build -T -b json -d _build/doctrees-json -D language=en . _build/json

from sphinx-gallery.

from sphinx-gallery.

Not as simple as I thought, reopening.

There are more builders used, as an example:
https://readthedocs.org/projects/seismicjl/builds/3264550/

has:

• readthedocs
• json
• readthedocssinglehtmllocalmedia
• latex
• epub

At the moment the readthedocs build fails at readthedocssinglehtmllocalmedia ...

and now it fails on the last one Edit: this wasn't meant to be there

from sphinx-gallery.

I have deactivated latex and epub. but https://github.com/Titan-C/sphinx-gallery/commits/refactor_split seems to work now. I list the allowed builders. only html and readthedocs

from sphinx-gallery.

Where do I get the readthedocs build from your branch ? I can't figure it out I am afraid.

from sphinx-gallery.

It's only the last commit. Titan-C@4dc8977

from sphinx-gallery.

What I am after is the readthedocs build i.e. the equivalent of https://readthedocs.org/projects/sphinx-gallery/builds/ but for your refactor_split branch.

from sphinx-gallery.

https://readthedocs.org/projects/sphinx-gallery-local/

from sphinx-gallery.

OK I used your whitelist of builders approach as a quick-fix. Maybe there is a more elegant solution though.

Also I think it'd be good to understand why readthedocs builds with these sphinx builders:

• readthedocs
• json
• readthedocssinglehtmllocalmedia

from sphinx-gallery.