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

fix: avoid infinite loop in docs-live #1265

Merged
merged 3 commits into from
Jun 8, 2023
Merged

Conversation

12rambau
Copy link
Collaborator

Fix #1256

I didn't really get what the stb serve was used for so I rewrote the nox "docs-live" session the same way as in https://github.com/pradyunsg/sphinx-theme-builder/blob/16979342306d885f4a99c195628001be61e98e5a/noxfile.py#L23.

I don't experience the infinite loop anymore. My only question is what changes should we listen to ? the one from the documentation or the one from the src (or both) ?

This current implementation listen to the docs but as I'm never using it I don't know if it's the way people use it.

@drammock
Copy link
Collaborator

I think you rather need to mirror what is done here:

https://github.com/pradyunsg/sphinx-theme-builder/blob/16979342306d885f4a99c195628001be61e98e5a/src/sphinx_theme_builder/_internal/cli/serve.py#L74-L125

In particular the --watch argument is what makes sphinx-autobuild monitor the source tree as well as the docs pages. Then we need to change what is passed to the --re-ignore argument so that the translation files are ignored too.

@drammock
Copy link
Collaborator

...or, we could PR into stb to expose an --ignore argument that is passed through (probably best appended to) --re-ignore, and then use that new --ignore in our existing call to stb serve. Probably better to leave that for later, though, since it's currently unusable and we want a quick fix. But pinging @pradyunsg here, as a heads-up that we have a use case for exposing (or passing additional elements to) --re-ignore in stb serve

@choldgraf
Copy link
Collaborator

I actually chatted with pradyun a bit about this here:

pradyunsg/sphinx-theme-builder#24 (comment)

But i don't believe there has been any movement on this yet. Maybe he'd be open to a PR

@drammock
Copy link
Collaborator

drammock commented Apr 23, 2023

I've rebased and (force-)pushed a change here that works for me locally when I use pradyunsg/sphinx-theme-builder#41. Once that is merged and a new STB release is cut, then we can re-trigger the CIs here and hopefully they'll all pass.

@drammock drammock marked this pull request as ready for review June 8, 2023 15:35
@drammock
Copy link
Collaborator

drammock commented Jun 8, 2023

I'm going to self-merge this one as it only affects interactive dev testing using nox -s docs-live

@drammock drammock merged commit 19ab283 into pydata:main Jun 8, 2023
@12rambau 12rambau deleted the infinite branch June 8, 2023 17:09
@trallard trallard mentioned this pull request Jun 13, 2023
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.

infinite loop in nox -s docs-live
3 participants