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

make spelling checks spelling of stale BUILDDIR #225

Open
ca-scribner opened this issue May 3, 2024 · 1 comment
Open

make spelling checks spelling of stale BUILDDIR #225

ca-scribner opened this issue May 3, 2024 · 1 comment
Assignees
Labels
bug Something isn't working question Further information is requested

Comments

@ca-scribner
Copy link

I don't quite understand what is going on, but what I observe is that if I fix a spelling mistake and then do make spelling, sometimes I still have an old _build that gets checked and causes the spelling check to fail. I end up doing a lot of rm -rf _build; make spelling to avoid repeating myself, and I think probably the makefile could be modified to avoid that.

@ru-fu
Copy link
Contributor

ru-fu commented May 3, 2024

This sounds strange ... my guess is that it is related to incremental building. By default, Sphinx only builds files that have changed - but then, if you fixed a spelling mistake, that file has changed and should be built again.
We could of course force a clean build for the spelling check, but that would increase the time for the check even more.

Do you normally use make html or make run? make run can be weird sometimes.

Or, another idea - is the spelling mistake in a page title? That would mean that the page in question is built again, but the navigation in the other pages isn't, so the error would still be reported. Maybe we do need to force a clean build. :(

@ru-fu ru-fu added bug Something isn't working question Further information is requested labels May 3, 2024
@akcano akcano self-assigned this Jun 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants