[DOC/BUILD] add ability to selectively build docs #24906

Activity

1. jklymak

   added

   Documentation: buildbuilding the docsbuilding the docs

   on Jan 7, 2023
2. jklymak commented on Jan 8, 2023

   

   jklymak

   on Jan 8, 2023

   MemberAuthor

   More actions

   OK, I looked into this for a while. This is currently really easy to do in conf.py. After the initial gallery builds, doing

   exclude_patterns = [
       'api/prev_api_changes/api_changes_*/*',
       'users/prev_whats_new/*',
       'gallery/*',
       'api/*',
       'tutorials/*',
       'plot_types/*',
       'devel/*'
   ]
   

   means that you can build the docs in 5 seconds or so (on my machine). The first build is still really slow because it doesn't stop sphinx-gallery from running. If you further set example_dirs to an empty list, the whole build is super fast.

   So I wonder if we should just document this for folks. I definitely didn't understand how exclude_patterns works, but now that I do, I'm not sure it's worth having a bunch of hooks or environment variables we check.
3. rcomer commented on Jan 8, 2023

   

   rcomer

   on Jan 8, 2023

   Last edited by rcomer

   Member

   More actions

   The first build is still really slow because it doesn't stop sphinx-gallery from running.

   What happens if you use this together with the make html-noplot option?

   Edit: on second thoughts your approach of modifying example_dirs is clearly better as you might want the tutorials but not the gallery and plot types.
4. jklymak

   closed this as completedin #24907on Jan 14, 2023
5. QuLogic

   added this to the v3.8.0 milestone on Jan 16, 2023