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

support sphinx i hope #278

Merged
merged 1 commit into from
Apr 18, 2024
Merged

support sphinx i hope #278

merged 1 commit into from
Apr 18, 2024

Conversation

nabobalis
Copy link
Contributor

@nabobalis nabobalis commented Apr 18, 2024

Fixes #277

@nabobalis nabobalis changed the title pin + changelog support sphinx i hope Apr 18, 2024
@nabobalis nabobalis marked this pull request as ready for review April 18, 2024 16:58
@nabobalis nabobalis merged commit 2e3ac8d into main Apr 18, 2024
8 of 11 checks passed
@nabobalis nabobalis deleted the pin branch April 18, 2024 17:57
Comment on lines +123 to +124
# Modern Sphinx now errors instead of returning the default if there is not a value
# in any of the config files.
Copy link

Choose a reason for hiding this comment

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

I think it is worse than that, new version of sphinx always return the default. It never looks in config files for things that are not theme, or options.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Did that patch that? I need to learn how sphinx works in more detail.

Copy link

Choose a reason for hiding this comment

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

Well, the code will work but the comment is not technically correct. Sphinx 7.3.0 to 7.3.6 will indeed error.

But sphinx 7.3.7 and above will just ignore the config and return the default value (False in this case).

https://github.com/sphinx-doc/sphinx/blob/de4ac2fbdebae529a973910e96794645158f0401/sphinx/theming.py#L123-L134

Basically sphinx removed support for custom sections.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In that case, I will need to work out how to handle this in a manner that sphinx likes.

But for now, I will just ignore this and pretend it didn't break.

Copy link

Choose a reason for hiding this comment

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

sounds like a plan.

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.

ablog doesn't work with sphinx >=7.3.0
2 participants