speedup sphinx build with caching pip

[smoench]

No description provided.

[javiereguiluz]

@smoench this is really nice. Thanks for all your help to improve the performance of the doc linter.

[wouterj]

Thanks a lot!

In the CMF docs, we also cached $HOME/.cache/pip, to speed up pip. Maybe that's an option here as well?

[smoench]

Sure, I was also thinking about that

[OskarStark]

Nice Improvement ✌🏻

[smoench]

I don't know what causes following error:

Warning, treated as error:
/home/runner/work/symfony-docs/symfony-docs/form/form_customization.rst:None: WARNING: duplicate label form-customization-sidebar, other instance in /home/runner/work/symfony-docs/symfony-docs/form/form_themes.rst

[wouterj]

I don't know what causes following error:

Hmm, that reference target (form-customization-sidebar) lives in form/form_customization.rst in 3.4 and in form/form_themes.rst for the newer versions. Seems like the cache is maybe shared among all branches, resulting in this error? Or does the docs somehow render a wrong version of the documentation?

[smoench]

On the first try the base branch was on master but changed I changed it to 3.4. I thought it wouldn't matter as of the cache restrictions https://help.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache.
I changed cache keys now.

But some how after the cache hit and cache file has been extracted, sphinx thinks all files has been changed. So cache does not work properly 🤷‍♂

[OskarStark]

So we only go with the pip cache and not the other ones?

[smoench]

Unfortunately, yes! But perhaps someone can confirm that it is working with a more latest sphinx version than 1.3.6.

[smoench]

Well, Sphinx uses mtime (in all versions) for detecting changes. This works on a local machine but not in a CI that makes a fresh checkout.

[OskarStark]

Thank you Simon.