Update docs readme #386
Merged
Update docs readme #386
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
Pursuant to #379, this seemed like a good thing to make as a quick fix, with the more substantial restructuring to occur later. Notably this requires using conda, which not all users may rely on. I do not know if there is a way to expose the `environment.yml` file to a `pip` command for non-conda users, but it seems like it shouldn't be a long run requirement that you use `conda` in order to build our docs.
|
@minrk FYI. This Travis build has one of the intermittent kernel dying messages during one of the tests. https://travis-ci.org/jupyter/nbconvert/jobs/156625723 @michaelpacer Thanks for doing this. I agree that it's worthwhile to add instructions on building locally with pip too. I'm going to merge this now, and we can follow up with pip in a future PR. ☀️ |
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.
Pursuant to #379, this seemed like a good thing to make as a quick fix, with the more substantial restructuring to occur later.
Notably this requires using conda, which not all users may rely on. I do not know if there is a way to expose the
environment.ymlfile to apipcommand for non-conda users, but it seems like it shouldn't be a long run requirement that you usecondain order to build our docs.cc @willingc