Skip to content

Build: check for _build/html directory and fail if exists #10126

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

Merged
merged 2 commits into from
Mar 9, 2023

Conversation

humitos
Copy link
Member

@humitos humitos commented Mar 8, 2023

Example of a failed build:

Screenshot_2023-03-08_10-32-09

Continuation of #10038
Closes #10036

@humitos humitos requested a review from agjohnson March 8, 2023 09:32
@humitos humitos requested a review from a team as a code owner March 8, 2023 09:32
@humitos humitos requested a review from benjaoming March 8, 2023 09:32
Comment on lines 55 to 61
BUILD_OUTPUT_OLD_DIRECTORY_USED = gettext_noop(
"Your project is outputting files to an old directory ('_build/html') "
"when building the docs. "
"Note this directory is not used anymore and the result may be unexpected. "
"Please, check your build process looking for this directory and replace it by "
"the path '$READTHEDOCS_OUTPUT/html' instead."
)
Copy link
Member Author

Choose a reason for hiding this comment

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

@agjohnson feel free to suggest a better message here.

@humitos humitos enabled auto-merge (squash) March 9, 2023 08:37
@humitos
Copy link
Member Author

humitos commented Mar 9, 2023

Thanks for your suggestions. Both were better than mine 😅 -- I merged Anthony's one and I'm moving forward with this.

@humitos humitos merged commit dd07a3e into main Mar 9, 2023
@humitos humitos deleted the humitos/old-output-fail-build branch March 9, 2023 08:53
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.

Warn users if anything is written to old artifact directory
3 participants