3
0
Fork 0
forked from mirrors/nixpkgs
nixpkgs/doc
Benjamin Hipple c88290789c doc: Rewrite python onboarding tutorials in manual
Based on some feedback in #87094 and discussion with @fridh, this re-organizes
the onboarding tutorial in the Nixpkgs manual's python section, so that we start
with the simplest, most ad-hoc examples and work our way up. This progresses
from:

1. How to create an temporary python env at the cmdline, then
2. How to create a specific python env for a single script, then
3. How to create a specific python env for a project in a shell.nix, then
4. How to install a specific python env globally on the system or in a user profile.

Additionally, I've tried to standardize on some of the "best practice" ways of
doing things:

1. Instead of saying that this command style is "supported but strongly not
   discouraged", I've just deleted it to avoid confusion.

   Bad:  nix-shell -p python38Packages.numpy python38Packages.toolz
   Good: nix-shell -p 'python38.withPackages(ps: with ps; [ numpy toolz ])'

2. In the portion where we show how to add stuff to the user's
   `XDG_CONFIG_HOME`, use overlays instead of `config.nix`. The former can do
   everything the latter can do, but is also much more generic and powerful,
   because it can compose with other files, compose with other envs, compose
   with overlays that do things like swap whether tensorflow and pytorch are
   built openblas/mkl/cuda stacks, and so on. The user is eventually going to
   see the overlay, so to avoid confusion let's standardize on it.
2020-05-15 22:43:16 +02:00
..
builders treewide: per RFC45, remove more unquoted URLs 2020-04-18 14:04:37 +02:00
contributing treewide: use https for nixos.org and hydra.nixos.org 2020-05-03 22:14:21 -07:00
doc-support Revert "make-tarball.nix: Restore the 'commit' field in packages.json" 2020-03-29 20:57:50 +02:00
functions Merge pull request #68491 from roberth/fix-dontRecurseIntoAttrs 2020-03-01 11:05:34 +01:00
languages-frameworks doc: Rewrite python onboarding tutorials in manual 2020-05-15 22:43:16 +02:00
old treewide: per RFC45, remove more unquoted URLs 2020-04-18 14:04:37 +02:00
stdenv Remove outdated reference to nix-log2xml 2020-05-07 16:01:29 +02:00
using doc/using/overlays.xml: update LD_LIBRARY_PATH example 2020-04-22 21:54:41 -04:00
.gitignore doc: format the documentation (#57102) 2019-03-08 21:07:11 -08:00
default.nix doc: move parameters to an XML file 2019-07-04 09:16:06 -04:00
functions.xml doc: move fhs and mkShell under builders/special 2019-10-21 11:39:46 +02:00
Makefile nixpkgs manual: fix build after pandoc(?) update 2020-03-02 08:24:54 +01:00
manual.xml nixpkgs manual: move builders into one folder 2019-10-30 11:17:14 +01:00
overrides.css doc: Make callout marks in code unselectable 2020-01-14 15:24:57 +01:00
preface.chapter.md treewide: use https for nixos.org and hydra.nixos.org 2020-05-03 22:14:21 -07:00
release-notes.xml treewide: use https for nixos.org and hydra.nixos.org 2020-05-03 22:14:21 -07:00
shell.nix Generate links to function definitions 2018-10-05 11:20:46 -04:00
style.css manual: limit text width 2019-01-08 15:08:42 +00:00