Skip to content

Add users/explain to default skip subdirs#26905

Merged
jklymak merged 1 commit intomatplotlib:mainfrom
rcomer:build-skip-userguide
Sep 24, 2023
Merged

Add users/explain to default skip subdirs#26905
jklymak merged 1 commit intomatplotlib:mainfrom
rcomer:build-skip-userguide

Conversation

@rcomer
Copy link
Copy Markdown
Member

@rcomer rcomer commented Sep 24, 2023

PR summary

I had reason to git clean and then the next time I ran make html-skip-subdirs, it spend a while generating users/explain. Adding 'users/explain/*' to the list of default skipped subdirs fixed that.

PR checklist

@rcomer rcomer added the Documentation: build building the docs label Sep 24, 2023
@rcomer rcomer added this to the v3.9.0 milestone Sep 24, 2023
Copy link
Copy Markdown
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a little confused though since users/explain is a symlink of galleries/user_explain

@rcomer
Copy link
Copy Markdown
Member Author

rcomer commented Sep 24, 2023

I think for the galleries this list refers to the generated directories under doc (hence "gallery" rather than "examples"). There is logic further down that maps them back to the directories that sphinx-gallery uses to create them

matplotlib/doc/conf.py

Lines 228 to 235 in 37f26da

gallery_dirs = [f'{ed}' for ed in
['gallery', 'tutorials', 'plot_types', 'users/explain']
if f'{ed}/*' not in skip_subdirs]
example_dirs = []
for gd in gallery_dirs:
gd = gd.replace('gallery', 'examples').replace('users/explain', 'users_explain')
example_dirs += [f'../galleries/{gd}']

@jklymak
Copy link
Copy Markdown
Member

jklymak commented Sep 24, 2023

What does gets built if you do this?

@rcomer
Copy link
Copy Markdown
Member Author

rcomer commented Sep 24, 2023

What does gets built if you do this?

Not much! FAQs, Getting Started, Installation, Next What's New, 3.8 GitHub stats, Project information, External Resources.

But the way I've been using it is: run once to generate the default skip-subdir file, comment out the things I do want to build, and then run it again.

@jklymak jklymak merged commit 7d2acfd into matplotlib:main Sep 24, 2023
@rcomer rcomer deleted the build-skip-userguide branch September 25, 2023 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation: build building the docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants