Make alabaster and sphinx_rtd_theme dependencies optional #2097

Merged
merged 1 commit into from Jan 19, 2016

Conversation

Projects
None yet
6 participants
Contributor

mitya57 commented Oct 24, 2015

There is no need to pull these dependencies if i.e. the documentation is using the classic theme.

There will be no change in behavior for projects using alabaster or sphinx_rtd_theme.

Note: this PR does not remove these dependencies from setuptools requires list, as this can potentially break some reverse dependencies. If you think we should do this, please let me know and I will amend the PR. This change will be useful for us (Debian) anyway as we will be able to remove sphinx-rtd-theme from our our list of dependencies.

Contributor

keimlink commented Oct 27, 2015

Seems reasonable! 👍

Owner

birkenfeld commented Oct 27, 2015

At least alabaster cannot be removed since it is the new default. The rtd theme was supposed to be merged, but the rtd guys wanted to have a little more time to do some changes, so we used the dependency solution to give them more flexibility.

Maybe it is time to revisit these choices for 1.4.

Contributor

mitya57 commented Oct 27, 2015

@birkenfeld This PR does not change anything functionally, it just moves imports to where they are actually used.

As I said, I will be happy if at least sphinx-rtd-theme was removed from requirements (or merged), but this is not included in this pull request.

Contributor

mitya57 commented Oct 29, 2015

Maybe it is time to revisit these choices for 1.4.

I am happy to retarget this PR to default branch, in case you do not want it in 1.3 (though, as I said, it doesn't break any existing setups).

@shimizukawa shimizukawa added this to the 1.4 milestone Nov 15, 2015

@shimizukawa shimizukawa added the html label Nov 15, 2015

Contributor

vitaut commented Nov 15, 2015

👍 but I think it's even more important to remove dependencies from requires in setup.py. I did this in #2087 but only for sphinx-rtd-theme. The same could be done for alabaster.

Contributor

mitya57 commented Nov 16, 2015

@vitaut Your PR is what I would like to be done, but mine is absolutely safe (i.e. it doesn't break anything), while yours can potentially introduce incompatibilities.

shimizukawa added a commit that referenced this pull request Jan 15, 2016

Merge pull request #2087 from cppformat/optional-rtd
refs #2087, #2086, #1845, #2097: Make sphinx_rtd_theme optional
Owner

shimizukawa commented Jan 15, 2016

I've read this thread again, and +1 for this PR to merge into stable. If no objection, I'm going to merge into stable for sphinx-1.3.5.

Owner

tk0miya commented Jan 16, 2016

@shimizukawa please tell me the plan of these dependencies before merging.
I hear the alabaster is default theme, and sphinx_rtd_theme will be removed at 1.4 (by #2087).
Is any reason to merge this? If you mean lazy loading of these themes, I agree.
Or not, I think we have to discuss more about the plan.

(I understand this is no breaking change, but I do not understand where we goes)

@tk0miya tk0miya added html theme and removed html labels Jan 16, 2016

Owner

shimizukawa commented Jan 17, 2016

@tk0miya

Is any reason to merge this? If you mean lazy loading of these themes, I agree.
Or not, I think we have to discuss more about the plan.

The former one.

Owner

tk0miya commented Jan 17, 2016

@shimizukawa I understand. LGTM!

@shimizukawa shimizukawa modified the milestones: 1.3.5, 1.4 Jan 18, 2016

Make alabaster and sphinx_rtd_theme dependencies optional
There is no need to pull these dependencies if i.e. the documentation is
using the classic theme.

There will be no change in behavior for projects using alabaster or
sphinx_rtd_theme.
Contributor

mitya57 commented Jan 19, 2016

FWIW I've rebased this pull request against the latest stable branch.

shimizukawa added a commit that referenced this pull request Jan 19, 2016

Merge pull request #2097 from mitya57/stable
Make alabaster and sphinx_rtd_theme dependencies optional

@shimizukawa shimizukawa merged commit dcdcdb4 into sphinx-doc:stable Jan 19, 2016

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Owner

shimizukawa commented Jan 19, 2016

Merged. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment