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

Sphinx/docs: Avoid usage of deprecated style keyword #8709

Merged
merged 1 commit into from May 4, 2024

Conversation

kbaikov
Copy link
Contributor

@kbaikov kbaikov commented Apr 28, 2024

Fixes: #8230

Style keyword is deprecated in sphinx 7.x

Maintainer merge checklist

  • Title is descriptive/clear for inclusion in release notes.
  • Applied a Component: xxx label.
  • Applied the api-deprecation or api-break label.
  • Applied the release-highlight label to be highlighted in release notes.
  • Added to the milestone version it was merged into.
  • Unittests are included in PR.
  • Properly documented, including versionadded, versionchanged as needed.

Copy link

welcome bot commented Apr 28, 2024

Thanks for opening your first pull request here! 💖 Please check out our contributing guidelines.

Copy link
Member

@misl6 misl6 left a comment

Choose a reason for hiding this comment

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

Hi @kbaikov ,

That's nice that you started working on an open issue (#8230) for Kivy 3.0.0, however I do not think that's the proper way to target this issue.

Can you please explain your changes?

@kbaikov
Copy link
Contributor Author

kbaikov commented Apr 30, 2024

Hi @misl6

Thank you for a quick reply.
So my thinking was to install sphinx version 7.x and try to build kivy documentation with a simple make target.
make html or make -C doc html
This is the minimal fix that makes the docs to build.

Perhaps i am missing something else. Please direct me.
Thanks!

@misl6
Copy link
Member

misl6 commented May 1, 2024

So my thinking was to install sphinx version 7.x and try to build kivy documentation with a simple make target.
Yep, that build is also performed by our CI/CD pipeline, and we can configure to do that with sphinx 7.x.x.

Did you checked https://github.com/sphinx-doc/sphinx/pull/11381/files ? It looks like to me we actually need to support more stylesheets, and definitely we do not need to change style to styles in this HTML tag.

@kbaikov
Copy link
Contributor Author

kbaikov commented May 2, 2024

@misl6
Indeed, thank you.
Please take a look at the latest change.
This builds in the latest sphinx and leaves the HTML tag alone.

doc/sources/.templates/layout.html Outdated Show resolved Hide resolved
Fixes: 8230

Style keyword is deprecated in sphinx 7.x
@kbaikov
Copy link
Contributor Author

kbaikov commented May 2, 2024

Fixed a typo.

@misl6 misl6 changed the title Remove deprecated style keyword Sphinx/docs: Avoid usage of deprecated style keyword May 4, 2024
@misl6 misl6 added the Component: documentation Documentation or examples label May 4, 2024
@misl6 misl6 added this to the 3.0.0 milestone May 4, 2024
Copy link
Member

@misl6 misl6 left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you!

@misl6 misl6 merged commit bde597c into kivy:master May 4, 2024
29 checks passed
Copy link

welcome bot commented May 4, 2024

Congrats on merging your first pull request! 🎉🎉🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: documentation Documentation or examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sphinx 7.0.0 is incompatible due to usage of style key.
2 participants