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

upgrade the version of sphinx-rtd-theme to fix "style is undefined" #148

Merged
merged 6 commits into from
Aug 5, 2024

Conversation

ceblanton
Copy link
Collaborator

@ceblanton ceblanton commented Aug 5, 2024

Describe your changes

Our sphinx CI building suddenly stopped working with this error:

Reason: UndefinedError("'style' is undefined")

Others have found that the cause is a mismatch between sphinx and sphinx-rtd-theme, and is fixed by updating the latter.

readthedocs/sphinx_rtd_theme#1571

Issue ticket number and link (if applicable)

Checklist before requesting a review

  • I ran my code
  • I tried to make my code readable
  • I tried to comment my code
  • I wrote a new test, if applicable
  • I wrote new instructions/documentation, if applicable
  • I ran pytest and inspected it's output
  • I ran pylint and attempted to implement some of it's feedback

…rror

Appears to be caused by a mismatch of sphinx and sphinx-rtd-theme
readthedocs/sphinx_rtd_theme#1571
@ceblanton ceblanton changed the title python adventures upgrade the version of sphinx-rtd-theme to fix "style is undefined" Aug 5, 2024
@ilaflott ilaflott self-requested a review August 5, 2024 20:56
@ceblanton ceblanton marked this pull request as ready for review August 5, 2024 20:59
@ceblanton
Copy link
Collaborator Author

#124

@ilaflott
Copy link
Member

ilaflott commented Aug 5, 2024

I think we should be staying consistent between pip and conda in a way that seems intentional and non-arbitrary. I prefer the current version-

          pip install sphinx renku-sphinx-theme sphinx-rtd-theme
          pip install --upgrade sphinx-rtd-theme

i wonder if the renku one can be omitted, and the --upgrade flag can be added elsewhere for even more brevity? I'll try it out.

          pip install --upgrade sphinx sphinx-rtd-theme

@ilaflott
Copy link
Member

ilaflott commented Aug 5, 2024

no one-liner :-( but consistent

@ilaflott ilaflott merged commit 26a887f into main Aug 5, 2024
1 of 3 checks passed
@ilaflott ilaflott deleted the fix-docs branch August 5, 2024 21:16
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