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

Update Sphinx and requirements #10158

Merged
merged 1 commit into from
Nov 2, 2024

Conversation

Piralein
Copy link
Member

@Piralein Piralein commented Oct 28, 2024

supersede #7443

  • Update CI OS version for sphinx 8.x support (I guess phyton version?)

  • disable social cards, because of warnings

  • remove html_theme_path and display_version as this are outdated options

  • remove search css, as this shouldn't be required anymore

  • remove cache busters, as this is now integrated

  • remove pinned dependencies

  • update dependencies

  • class_scripteditor.rst: document is referenced in multiple toctrees: ['classes/index', 'classes/index'], selecting: classes/index <- classes/class_scripteditor is an information and can't be suppressed, like a warning. (as far as I know)

@Piralein Piralein added the dependencies Pull requests that update a dependency file label Oct 28, 2024
@mhilbrunner mhilbrunner self-requested a review October 28, 2024 22:48
@Piralein Piralein marked this pull request as ready for review November 1, 2024 07:27
@mhilbrunner mhilbrunner added bug enhancement python Pull requests that update Python code labels Nov 1, 2024
@mhilbrunner
Copy link
Member

mhilbrunner commented Nov 1, 2024

I've been testing this these past few days and had no issues, so I think we can go ahead with this, considering the current trouble with the outdated build we currently use. Both the web/HTML build and the EPUB one seem to work.

class_scripteditor.rst: document is referenced in multiple toctrees: ['classes/index', 'classes/index'], selecting: classes/index <- classes/class_scripteditor is an information and can't be suppressed, like a warning. (as far as I know)

The discussion on the Sphinx 8.1 release at first made me think this was just an error on the Sphinx side (see this issue: sphinx-doc/sphinx#13012). And to quote:

for now, the lines are safe to ignore -- they're informational only. We will see if there is something we can do to improve the experience

However, it felt a bit odd that this only happens to a very limited set of files in the class reference: Editor-only classes, and Node/Resource/Object.

It seems they are the classes that are listed more than once in the class reference index (classes/index.rst, autogenerated by make_rst.py in the main engine repo).

For example, class_editorcommandpalette is listed once in the general Nodes toctree in that file, and a second time in the Editor-only toctree. For now, this only seems to result in a a warning; both generated links in the sidebar appear to work. However, we may need to think about fixing this behaviour in the future.

I guess for social cards, you mean these warnings?

WARNING: [Social card] image cannot be an SVG image, skipping...

@Piralein
Copy link
Member Author

Piralein commented Nov 2, 2024

I guess for social cards, you mean these warnings?

WARNING: [Social card] image cannot be an SVG image, skipping...

Yes, I haven't checked if this is still an issue. I added it at the time and never removed it as we probably don't want them anyway.

Copy link
Member

@mhilbrunner mhilbrunner left a comment

Choose a reason for hiding this comment

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

It definitely is still an issue. Not sure if wanted or not, I think social cards were at least nice once upon a time for Twitter, but with how that whole thing is going, well. Alright, not that much of a priority anyway, let's go ahead and merge this and see how it pans out for everyone on master/latest at least. Thanks for your work :)

@mhilbrunner
Copy link
Member

Cherrypicked to 4.3 in #10346.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants