Commit Graph

542 Commits

Author SHA1 Message Date
github-actions[bot]
55b348fe1b
Merge master into staging-next 2020-12-05 06:16:24 +00:00
Ryan Mulligan
25e00d8c7e
Merge pull request #105648 from AndersonTorres/wip-documentation
Documentation updates from Docbook to CommonMark
2020-12-04 21:37:09 -08:00
AndersonTorres
f5baf84be5 Convert OCaml from DocBook to CommonMark 2020-12-04 23:35:26 -03:00
github-actions[bot]
6f36a7f7c3
Merge master into staging-next 2020-12-03 06:15:27 +00:00
Lucas Eduardo
543f084d62
doc: TeX Live to CommonMark
* converted texlive doc to markdown

Signed-off-by: GitHub <noreply@github.com>

* Remove frontmatter (suggestion)

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>

* Add anchor (suggestion)

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>

* apply suggestions from @ryantm

Signed-off-by: GitHub <noreply@github.com>

* fix nesting of codeblocks into list items as suggested by @jtojnar

Signed-off-by: GitHub <noreply@github.com>

* add anchors for subtopics as said by @jtojnar

Signed-off-by: GitHub <noreply@github.com>

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>
2020-12-02 21:15:18 -08:00
Frederik Rietdijk
ff90abd5dd Merge staging-next into staging 2020-12-01 14:23:10 +01:00
Ryan Mulligan
795f75f21d
Merge pull request #105230 from Mic92/java-doc
doc/java: convert to markdown
2020-11-30 21:57:35 -08:00
Ryan Mulligan
7812bf4535
Merge pull request #105120 from wayofthepie/coq-to-commonmark
doc: convert coq to commonmark
2020-11-30 21:44:54 -08:00
Jan Tojnar
27b974d84b
Merge branch 'staging-next' into staging 2020-12-01 03:26:36 +01:00
Wil Taylor
b6bca3d806
doc/Qt: migrate to CommonMark (#105004)
* Updated QT section

* Fixed trailing whitespace

* Update doc/languages-frameworks/qt.section.md

Co-authored-by: Jan Tojnar <jtojnar@gmail.com>

* Update doc/languages-frameworks/qt.section.md

Co-authored-by: Jan Tojnar <jtojnar@gmail.com>

* Made changes to docs as per jtojnar's review

* Added docbook tags for callouts back in

Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2020-11-29 20:30:29 -08:00
John Ericson
73425f6c3b Merge remote-tracking branch 'upstream/master' into staging 2020-11-28 21:33:03 -05:00
John Ericson
b7650aaa77 rust: Clean up target configs and test some more
See the new docs for details. The difference is vis-a-vis older versions
of this PR, not master.
2020-11-28 19:36:28 +00:00
John Ericson
8ddf5c6907 Merge remote-tracking branch 'upstream/master' into aj-rust-custom-target 2020-11-28 18:10:38 +00:00
John Ericson
c6617d28ef Merge remote-tracking branch 'upstream/master' into aj-rust-custom-target 2020-11-28 17:09:12 +00:00
Ryan Mulligan
3c40c276fa
Merge pull request #105200 from ryantm/update-ruby-doc
doc: Ruby to CommonMark
2020-11-28 07:34:45 -08:00
Jörg Thalheim
762e414d6a
doc/java: convert to markdown 2020-11-28 15:29:04 +01:00
Jörg Thalheim
bc9313d088
Merge pull request #105025 from Mic92/go-doc
doc/go: convert to markdown
2020-11-28 15:03:51 +01:00
Jörg Thalheim
4844ca43d8
Merge pull request #67496 from mb21/patch-1
Docs: clarify Rust overlay on non-NixOS
2020-11-28 14:29:04 +01:00
Jörg Thalheim
80b395015b
doc/go: convert to markdown 2020-11-28 07:32:10 +01:00
applePrincess
698111962e
doc/python: Fix shebang link (#105196) 2020-11-28 04:06:50 +01:00
Ryan Mulligan
6c70fdfd07 doc: ruby improvements
* no hard wrapping
* use ShellSession and nix info strings
* preserve old section anchor link
* update references to present default version
2020-11-27 19:00:41 -08:00
Kamron Mahmoodzadeh
495c2b5112 doc: use newer ruby documentation
With the addition of ruby.withPackages, manveru rewrote the nixpkgs
manual section for the ruby language but did not add it to the manual.
This commit replaces the previous documentation with manveru's updated
version.
2020-11-27 18:59:56 -08:00
Jan Tojnar
136152af80
Merge pull request #101537 from jtojnar/gtk-tracker 2020-11-28 01:37:37 +01:00
Stephen OBrien
a7e9047db3 doc: convert coq to commonmark 2020-11-27 08:13:55 +00:00
Jan Tojnar
95961244d3
doc/gnome: Document gdk-pixbuf setup hook
It was briefly mentioned in stdenv docs but since it interacts with wrapGAppsHook, it should be documented here.
2020-11-26 14:06:08 +01:00
Jan Tojnar
acfc45bacc
wrapGAppsNoGuiHook: init 2020-11-26 14:06:07 +01:00
Stephen OBrien
2bb9e7c18a doc: convert beam docs to commonmark 2020-11-26 11:30:17 +00:00
Felix Tenley
a94cc8dc92 dotnet: document new net packages 2020-11-11 15:35:23 -08:00
Kevin Cox
de57e3b630
Merge pull request #95165 from turion/patch-4
Doc -> Languages & Frameworks -> Rust: Update
2020-11-05 09:10:58 -05:00
Robert Hensing
d24360033d
Merge pull request #98383 from raboof/document-jre
openjdk: add derivation to generate bespoke minimal JRE's
2020-11-05 10:40:39 +01:00
Arnout Engelen
d4efa08b53
openjdk: add derivation to generate bespoke minimal JRE's
Co-Authored-By: Robert Hensing <robert@roberthensing.nl>
2020-11-04 17:47:18 +01:00
Doron Behar
80b96cf4ad
Merge pull request #100660 from fzakaria/faridzakaria/maven-documentation 2020-11-04 00:24:19 +02:00
Farid Zakaria
b9321adf1e documentation: add documentation for maven
Add nice markdown documentation for how to use mvn2nix plugin and the
buildMaven function within nixpkgs.

Update doc/languages-frameworks/maven.md

Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>

Apply suggestions from code review

Co-authored-by: Doron Behar <doron.behar@gmail.com>

Apply suggestions from code review

Co-authored-by: Doron Behar <doron.behar@gmail.com>

Apply suggestions from code review

Co-authored-by: Doron Behar <doron.behar@gmail.com>
2020-11-03 09:23:05 -08:00
Austin Butler
7fd9976af3 vimPlugins: document update proces 2020-10-28 13:51:24 -07:00
Peter Simons
5fe0939d18 The Haskell documentation has moved to <https://haskell4nix.readthedocs.io/>.
That site is generated automatically from the set of text files found at
<https://github.com/NixOS/cabal2nix/tree/master/doc>.
2020-10-23 21:00:26 +02:00
Aaron Janse
2bccf2e554 add documentation 2020-10-17 00:48:07 -07:00
Peter Simons
56bc587444 Merge remote-tracking branch 'origin/master' into haskell-updates, 2020-10-15 19:39:16 +02:00
John Ericson
c0df12de5d rust: Add support for managing target JSON in Nix 2020-10-14 04:20:23 +00:00
Frederik Rietdijk
748bc99520 docs: python39 is available 2020-10-13 18:53:40 +02:00
Kevin Cox
8b33d575e4
Merge pull request #98084 from turion/patch-5
agda.section.md: Fix header and enumeration
2020-10-11 07:29:58 -04:00
maralorn
0756b8a7bf
haskell-language-server: Init wrapper for multiple ghc versions at 0.5.0 (#99519)
* haskell-language-server: Init wrapper for multiple ghc versions at 0.5.0

* Fix closure size

* docs: Add hls section to Haskell part of manual
2020-10-10 16:01:57 +02:00
Manuel Bärenz
cd2dab91d6 Doc -> Languages & Frameworks -> Rust: Update
Add information on declarative overlay usage
2020-09-26 10:58:06 +02:00
Jörg Thalheim
a2960ac430
Merge pull request #97603 from zowoq/rust-test-threads 2020-09-25 06:19:23 +02:00
Jan Tojnar
6d518ddf77
Merge pull request #98503 from jtojnar/doc-prompts 2020-09-24 22:48:38 +02:00
Doron Behar
5819bca301 docs/go: Add examples for and explain buildFlags
Move common attributes treated by both buildGoModule and buildGoPackage
to a separate section, out of the examples' "callouts".

Co-authored-by: zowoq <59103226+zowoq@users.noreply.github.com>
2020-09-24 11:03:20 +10:00
zowoq
e4c71e6c6c buildRustPackage: support setting test-threads 2020-09-24 07:19:58 +10:00
Jan Tojnar
e1af37634b
doc: Improve code listings
By adding prompts and removing unnecessary indentation.
2020-09-23 01:25:25 +02:00
zowoq
069757550e doc/python: remove trailing whitespace 2020-09-21 09:35:27 +10:00
Manuel Bärenz
87cab901a3 agda.section.md: Fix header, enumerations, capitalisation 2020-09-18 12:42:06 +02:00
Alexandre Esteves
0cad09a68a docs/rust: fix typo
Co-authored-by: Drew <drewrisinger@users.noreply.github.com>
2020-09-10 19:10:27 +02:00
zowoq
23c781a810 buildGoPackage: check/delete vendor 2020-09-08 16:32:39 +10:00
Michele Guerini Rocco
2b575c5f1f
Merge pull request #96963 from doronbehar/doc/nodejs
doc: nodejs: Update override example to use overlays
2020-09-04 22:58:36 +02:00
Jake Waksbaum
58e585c93b vimPlugins: Document node-based plugins 2020-09-04 08:33:47 -07:00
Doron Behar
c67bcd23d4 doc: nodejs: Update override example to use overlays
Also: Add links so it'll be easier to find the referred files.
2020-09-02 19:00:46 +03:00
John Ericson
31dae7d627
Merge pull request #84047 from aaronjanse/document-android-emulator-variable
emulateApp: document $NIX_ANDROID_EMULATOR_FLAGS
2020-08-20 00:26:53 -04:00
Jonathan Ringer
233dc9c7d1
doc/python: Add pythonImportsCheck mention 2020-08-17 13:41:39 -07:00
Jonathan Ringer
93e7292976
doc/python: add pytestCheckHook section 2020-08-17 13:41:39 -07:00
zowoq
473536e3b5 buildRustPackage: remove platform.all from packages 2020-08-16 12:48:18 +10:00
Frederik Rietdijk
49f4475307
Merge pull request #95305 from jonringer/remove-py35
python35: remove
2020-08-15 09:08:47 +02:00
zowoq
961aa31455 buildGoModule: update deleteVendor docs 2020-08-14 07:50:37 +10:00
Jonathan Ringer
8c7d49b726
docs: update python interpreter versions 2020-08-12 21:57:40 -07:00
Matthew Mazzanti
2df0fda951 doc: Fix missing callout in go.xml
Pull #89453 introduced a bug in the documentation that is preventing the
hydra build for nixpkgs-unstable from finishing. I have added the
additional option indroduced in that patch (runVend for go modules) and
added the callout tag so that the documenation can build again.
2020-08-02 09:35:04 +10:00
zowoq
e703f3f34b
Merge pull request #89453 from c00w/vend
Add vend support to go-modules
2020-07-31 15:16:47 +10:00
zowoq
b3d71cd63d doc/*: editorconfig fixes 2020-07-31 15:06:53 +10:00
Colin L Rice
95be7b25be go-modules: Add useVend flag to go-modules 2020-07-28 21:11:28 -04:00
zowoq
ff3d205314 doc/perl: fix build 2020-07-18 15:12:37 +10:00
Jörg Thalheim
3829979d8d
Merge pull request #86589 from raboof/document-running-perl-scripts-from-the-shell
doc: add section on running ad-hoc Perl programs to the nixpkgs manual
2020-07-17 10:20:24 +01:00
Arnout Engelen
6093372069
Add section on running ad-hoc Perl programs to the nixpkgs manual
Co-authored-by: Timo Kaufmann <timokau@zoho.com>
2020-07-17 09:08:53 +02:00
Maximilian Bosch
19dfc1b011
Merge pull request #90689 from cole-h/fix-manual
agda: fix manual build -- blocks nixpkgs-unstable
2020-06-17 23:05:58 +02:00
Cole Helbling
5baa7541d7
agda: fix manual build
/build/doc/manual-full.xml:12764:35: error: ID "build-phase" has already been defined
    /build/doc/manual-full.xml:9029:33: error: first occurrence of ID "build-phase"
2020-06-17 13:51:43 -07:00
Lassulus
453014b456
Merge pull request #89245 from alexarice/agda-literate
agda: install literate files
2020-06-16 14:11:01 +02:00
Daniël de Kok
58ec4d5c77 doc: pip install flags are specified with pipInstallFlags
The documentation incorrectly stated that `installFlags` are passed to
`pip install`.
2020-06-16 10:03:25 +02:00
Jan Tojnar
acb53e0698
Merge branch 'staging-next' into staging 2020-06-10 04:10:57 +02:00
Rok Garbas
29c4fc94cf
Merge pull request #55302 from teto/lua_doc
doc: update lua documentation
2020-06-09 11:02:08 +02:00
Matthieu Coudron
8d05c66dc6 fixup! update 2020-06-07 20:12:56 +02:00
Matthieu Coudron
3042b38ce1 update 2020-06-06 20:20:27 +02:00
Matthieu Coudron
2909dc9f39 builds 2020-06-06 17:33:41 +02:00
Matthieu Coudron
404d057e89 Added an example about overlay 2020-06-06 17:33:39 +02:00
Matthieu Coudron
5cfcfc300b doc: update lua documentation
Reflects the recent changes to the lua infrastructure.
Packaging from luarocks should be encouraged.
2020-06-06 17:33:37 +02:00
Frederik Rietdijk
1c68570ab2 Merge staging-next into staging 2020-06-05 19:42:16 +02:00
Jörg Thalheim
f0396574ab
buildRustPackage: add documentation on how to create cargo.lock patches 2020-06-05 10:41:46 +01:00
Vladimír Čunát
677e3960b5
Merge #82342: rustPlatform: increase build-speed of checkPhase
...for rust-packages (into staging)
2020-06-05 09:12:30 +02:00
Frederik Rietdijk
b7ff746540 python3: now points to python38
Note this also means python3Minimal is now also Python 3.8.

This reverts commit eb1369670b and adds more.
2020-06-04 18:08:29 +02:00
Alex Rice
e215c3bcac
agda: install literate files 2020-06-01 13:59:20 +01:00
Maximilian Bosch
59e8e7a129
rust: improve docs
Co-authored-by: cole-h <cole.e.helbling@outlook.com>
Co-authored-by: asymmetric <lorenzo@mailbox.org>
2020-05-31 21:47:32 +02:00
Christian Albrecht
2312f5fbc4
Change to nodePackages and nodePackages_latest
currently LTS 12.x and Current 14.x
2020-05-29 18:25:11 +02:00
Jörg Thalheim
6602f87384
nodePackages: switch to 12
Signed-off-by: Christian Albrecht <christian.albrecht@mayflower.de>
2020-05-27 21:45:41 +02:00
Maximilian Bosch
6574ba1946
rust*: add docs for testing packages
See also https://discourse.nixos.org/t/rust-build-speed-improvements/7225
2020-05-24 18:37:34 +02:00
Uma Zalakain
196cc47005 agda: fix typo in library management documentation
Agda expects a "depend" (not "depends") field in the library description.
2020-05-24 14:20:05 +02:00
Jon
15b3d9d277
python3Packages.venvShellHook: add postVenvCreation (#87850)
* python3Packages.venvShellHook: add postVenvCreation

* python: docs: add postVenvCreation explaination
2020-05-16 09:34:11 +02:00
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
Dmitry Kalinkin
9943fd1a1d
Merge pull request #76653 from alexarice/agda-rework
Agda rework
2020-05-14 18:02:50 -04:00
Alex Rice
d30e2468e0
agda: rework builder 2020-05-14 20:54:11 +01:00
Colin L Rice
c5f18c44b1
go-modules: Doc updates 2020-05-14 07:21:52 +01:00
Benjamin Hipple
c3e2f98779 doc: use idiomatic overlay names in the python manual example
An overlay by any other name would function just as well, but we generally use
`self: super:` for the regular overlays, and `python-self: python-super`.
2020-05-09 18:02:20 -04:00
Benjamin Hipple
c0f434fcc8 doc: update python manual to reference python 3.8 instead of 3.5
Improvement suggested in #87094
2020-05-09 12:58:00 -04:00
Gabor Greif
dec283b463 ghcHEAD: 20200403 -> 20200505 2020-05-08 21:11:46 +02:00
José Romildo Malaquias
f528989650
Merge pull request #86198 from romildo/doc.icon-themes
gnome: document packaging icon themes
2020-05-07 10:50:50 -03:00
Frederik Rietdijk
9875bbae75 Merge master into staging-next 2020-05-05 19:51:09 +02:00
Pavol Rusnak
7b0167204d treewide: use https for nixos.org and hydra.nixos.org
tarballs.nixos.org is omitted from the change because urls from there
are always hashed and checked
2020-05-03 22:14:21 -07:00