Documentation: rewrite Python docs #13320
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
Member
FRidh
commented
Feb 21, 2016
FRidh
commented
- Update current documentation
- Add introduction/tutorial based on http://python-on-nix.readthedocs.org/en/latest/
- Convert to markdown so I can maintain it
- Include relevant wiki content
FRidh
added
9.needs: reporter feedback
FRidh
removed
the
9.needs: reporter feedback
| add a [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) to your script | ||
| specifying which dependencies Nix shell needs. With the following shebang, you | ||
| can use `nix-shell myscript.py` and it will make available all dependencies and | ||
| run the script in the `python3` shell. |
There was a problem hiding this comment.
Maybe a full example could help as reference here:
#! /usr/bin/env nix-shell
#! nix-shell -i python3 -p python3Packages.numpy
import numpy
print(numpy.__version__)There was a problem hiding this comment.
Simple and clear example. Thanks.
|
Just updated this PR. Unfortunately I get the following errors: |
|
Missed this. That error means you have a tag where it shouldn't be, but it won't tell you where. Good luck :) |
|
I'll look into it, looks amazing on first sight. |
| Dependencies such as libraries are automatically installed and should not be | ||
| installed explicitly. | ||
|
|
||
| The same goes for Python applications and Python packages that are used as |
There was a problem hiding this comment.
This is a tiny bit confusing. Maybe just drop this sentance? Not really sure what information it adds
|
Looks amazing, just a few nitpicks :) |
|
@FRidh: 🍻 |
|
Thanks for the feedback. I'm fine with removing myEnvFun. I'm a bit busy now but hopefully this weekend I can finish it. |
- Rewrite current documentation - Add introduction/tutorial - Convert to markdown
FRidh
added a commit
that referenced
this pull request
Mar 5, 2016
Documentation: rewrite Python docs
This was referenced Mar 5, 2016
|
Followup: #13700 (so participants get a notification) |
FRidh
referenced
this pull request
Jul 1, 2016
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.