update docs link #12
Merged
update docs link #12
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
AlpAribal
suggested changes
Mar 14, 2022
README.md
Outdated
| ``` | ||
| cd squirrel/ | ||
| mx build_docs | ||
| sphinx-build ./docs ./docs/build && open ./docs/build/index.html |
There was a problem hiding this comment.
open is a MacOS command I suppose, does not work for me. Maybe switch to a text line stating they should open the index.html with their favorite browser?
AlpAribal
reviewed
Mar 14, 2022
README.md
Outdated
Comment on lines
47
to
51
| (Currently we have not released a functional version of both packages into the public pypi registry for privacy. | ||
| Therefore, we ask you to use this installation method instead. In the documentation, you may also see some requirements | ||
| to install the two packages first, please follow the instruction above, instead of using | ||
| `pip install squirrel-core` and `pip install squirrel-datasets-core` directly. We kindly ask for your patience.) | ||
|
|
There was a problem hiding this comment.
Let's move this disclaimer to be the first line of Installation. We should add two lines to clone the repos first. Then for the editable install commands, we can state -e squirrel-core and -e squirrel-datasets-core
AlpAribal
reviewed
Mar 14, 2022
Co-authored-by: Alp Arıbal <[email protected]>
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.
Description
Update docs link (generate locally for beta testers)
Type of change
Checklist: