Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove any existing package doc_build_directory #141

Merged
merged 1 commit into from
Aug 29, 2024

Conversation

rkent
Copy link
Contributor

@rkent rkent commented Aug 12, 2024

Strange things can happen if there are leftover files in the docs_build directory. I recently came across one: if there is a previous run, then index.rst will already exist, so it will not be updated with index.rst.jinja if anything changes.

I cannot think of any good reason to leave the old docs_builds for the particular package, so this PR erases it at the beginning of the build.

Copy link
Member

@tfoote tfoote left a comment

Choose a reason for hiding this comment

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

This seems reasonable to me. If we're not getting appropriate speedups from caching (aka we're getting stale data) this is better. And I don't think that there's a case when someone should be putting content into this directory and expecting that it would persist.

@tfoote tfoote merged commit 927e22b into ros-infrastructure:main Aug 29, 2024
5 checks passed
@rkent rkent deleted the clean-docbuild branch September 1, 2024 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants