Improve local docs building docs to ensure all deps are installed #10918
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
|
+1, I think it's better to point to one simple way of building than three. All the packages needed, as far as I know, can easily be installed with pip. |
Member
|
Agreed, let's keep things simple. |
Member
|
Thanks ! |
Contributor
|
Super thorough thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
re: #10912 (review)
@jzf2101 @Carreau Working in a clean conda environment locally I found that it is necessary to do both a dev install and then add the deps from
docs/requirements.txt. So, this change links to the dev install instructions and then the requirements install.Works for either conda env or venv, but doesn't make sense to me in the debian package manager context, so I took that out (assuming we don't actually want to encourage system-wide installs for dev work - though I guess it's relevant if you are provisioning a VM or building a container, but then you probably don't need to be told, right?)