Update local build instructions in the docs #346
Merged
Conversation
This file contains 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds hints in the documentation to locally build scikit-decide with poetry.
More specifically, the documentation now indicates the environment variables that must be set prior to locally building and installing the library with poetry.
Not properly setting those environment variables can result in deactivating some options in scikit-decide, e.g. algorithm parallelism.
Those environment variables are set by the building and deployment github actions but they were not mentioned in the documentation for the people who want to build the library on their own.
The PR also updates the link to poetry's website and installation script which were outdated.