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

Make the first party extensions optional, add [extensions] extra #11747

Closed
wants to merge 1 commit into from

Conversation

hroncok
Copy link
Contributor

@hroncok hroncok commented Nov 6, 2023

This is my attempt to make all the sphinxcontrib requirements optional.

Feature or Bugfix

  • Feature

Purpose

We package sphinx in Fedora Linux and we don't really have a strong reason to pull in packages like applehelp there.
I decided to see if we could get rid of them.

Detail

Note that this is a very early draft. I am yet to test this in Fedora and see if this approach is feasible. It works for us.

If it is, this obviously requires some documentation changes and possible deprecations. I am however unable to drive that forward right now. I would be interested to hear from the Sphinx maintainers whether this approach makes sense or not at all.

Relates

@hroncok hroncok marked this pull request as draft November 6, 2023 12:47
@hroncok hroncok force-pushed the sphinxcontrib-optional branch from 347271f to c43c379 Compare November 6, 2023 13:06
pyproject.toml Show resolved Hide resolved
@hroncok
Copy link
Contributor Author

hroncok commented Nov 7, 2023

I have identified 5 Fedora packages that are impacted by this change. Most of them explicitly build the docs in some of the removed formats and are fixed by declaring a dependency on the particular sphinxcontrib package. One of them was a bit more interesting, as the tests only (accidentally) succeeded with sphinxcontrib_jsmath-1.0.1-py3.12-nspkg.pth insatlled: fastavro/fastavro#730

Long story short, we would like to have this change in Fedora. Please let me know if we should carry this downstream-only or if you are eventually interested as well.

@hroncok hroncok force-pushed the sphinxcontrib-optional branch 3 times, most recently from 91ed8f5 to 44e34be Compare November 8, 2023 15:28
@hroncok
Copy link
Contributor Author

hroncok commented Nov 8, 2023

The flake8 CI fails in a file I have not changed.

I proposed a fix in #11748

@hroncok hroncok force-pushed the sphinxcontrib-optional branch from 44e34be to a8371a9 Compare November 8, 2023 15:37
@hroncok hroncok changed the title [WIP] Make the first party extensions optional Make the first party extensions optional, add [extensions] extra Nov 9, 2023
@hroncok hroncok marked this pull request as ready for review November 9, 2023 10:15
@AA-Turner AA-Turner closed this Dec 26, 2023
@AA-Turner
Copy link
Member

This would be too painful a change in terms of deprecations at the moment, so I've closed this PR.

A

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants