8000 Document missing requirements for building the docs by twosigmajab · Pull Request #11292 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

Document missing requirements for building the docs #11292

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 15, 2018
Merged

Document missing requirements for building the docs #11292

merged 1 commit into from
Jun 15, 2018

Conversation

twosigmajab
Copy link
Contributor

Fixes #11286.

@amueller
Copy link
Member

thanks, lgtm!

@amueller amueller merged commit fb9e13d into scikit-learn:master Jun 15, 2018
@twosigmajab twosigmajab deleted the update-build-docs-requirements branch June 16, 2018 15:52
@twosigmajab
Copy link
Contributor Author
twosigmajab commented Jun 16, 2018 •
edited
Loading

@amueller @qinhanmin2014 et al.: Are you aware of the extras_require feature in setup.py? That seems like it would be appropriate to use here, to declare these optional "for building the docs only" requirements.

ref: https://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-extras-optional-features-with-their-own-dependencies

With that, a contributor would only need to run something like the simpler pip install -e .[docs] or pip install -e .[dev] etc. command once, when setting up their development environment, and the setup.py would be the programmatic, single source of truth for these dependencies, rather than your having to maintain them in the docs where they can get out of sync, and from which users would have to copy/paste the more complicated pip install docs_dependency1 docs_dependency2 ... command.

If you agree, this could be added in a future PR.

georgipeev pushed a commit to georgipeev/scikit-learn that referenced this pull request Jun 20, 2018
@twosigmajab
DOC add missing requirements for building docs (scikit-learn#11292)
773ae4c 
Fixes scikit-learn#11286.
@twosigmajab twosigmajab mentioned this pull request Jun 26, 2018
Closed
@twosigmajab
Copy link
Contributor Author

split off my previous comment into #11361 in case it's worth tracking separately

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@twosigmajab @amueller
0