Document make html-noplot as the default doc building method #5847
Conversation
There was a problem hiding this comment.
Those dependency errors are scary and not helpful.
I wonder if a better approach is to create a doc building method that skips any doc building where dependencies are missing. We can emit a warning but not fail. Plus still run some of the galleries when possible.
I'm approving this PR as I think it's on the right direction and we can perhaps consider the above proposal separately. Thought Nicolas?
|
Maybe we could have a way to bypass an example if there is some failure (the ffmpeg one isn't just a dependency problem but sometimes a dynamic loading issue as well). If someone wants to spend time on this, why not, but I think this will become less and less relevant as we add more examples. Eventually the doc building time will be dominated by the examples (if that's not already the case), and the need for skipping all example building will be even stronger than it is right now |
…#5847) Reviewed By: jdsgomes, NicolasHug Differential Revision: D36095703 fbshipit-source-id: 4c5e3305339f4a64d12546e77697b9d83270dddd
3 participants
This PR documents
make html-noplotbeforemake htmlin our contributing guide for building the docs.make html-noplotis enough in 99% of cases, andmake htmlcan throw a bunch of scary errors (looking at you ffmpeg example 👀 ).