Skip to content

Install either mkdocs or sphinx depending on document type #2979

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

Merged

Conversation

bsipocz
Copy link
Contributor

@bsipocz bsipocz commented Jun 28, 2017

This should address #2975 (comment)

@agjohnson - I'm not familiar with the mkdocs builds. Is sphinx and sphinx_rtd_theme required to be installed when the document type is mkdocs? If not, I can add a similar check for those dependencies.

@ericholscher
Copy link
Member

This looks like a great change. I merged @willingc's simple fix, but I like this one going forward. We should definitely be selecting the requirements based on project type, for both Conda & Pip. So +1 on doing the larger bit of work, and will deploy the simple fix now.

@bsipocz
Copy link
Contributor Author

bsipocz commented Jun 28, 2017

Great. Could you confirm that for mkdocs, neither of the above listed sphinx packages are required?

@willingc
Copy link
Contributor

I agree that @bsipocz's suggested solution is the best way to go forward. You should not need sphinx or the sphinx rtd theme with mkdocs.

@willingc
Copy link
Contributor

@ericholscher
Copy link
Member

Yep, mkdocs & Sphinx don't depend on each other at all, so both can be uninstalled in each environment.

@bsipocz
Copy link
Contributor Author

bsipocz commented Jun 28, 2017

Thanks. I should have rtfd at least here of all places :)

@bsipocz bsipocz force-pushed the mkdocs_dont_install_for_sphinx branch from 5604725 to 43ba326 Compare July 2, 2017 16:47
@bsipocz bsipocz changed the title mkdocs isn't required when documentation_type is sphinx Install either mkdocs or sphinx depending on document type Jul 2, 2017
@ericholscher
Copy link
Member

Thanks!

@ericholscher ericholscher merged commit d14cea0 into readthedocs:master Jul 17, 2017
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.

4 participants