Commit graph

2499 commits

Author SHA1 Message Date
pennae
2f76a3df64 doc: don't use docbook program listings/callouts
nixos-render-docs does not support this, and since the examples are
small there isn't that much value in callouts here. change them to
simple MD code blocks and lists instead.
2023-06-10 18:17:05 +02:00
pennae
2ecc93d6fe doc: normalize markdown for nixos-render-docs
pandoc recognizes `::: note` admonitions, nixos-render-docs only
recognizes `::: {.note}`. surprisingly pandoc also emits the correct
docbook tags for `[](#xref)`s, so we can use that too.
2023-06-10 18:17:05 +02:00
pennae
e42a5c78e7 doc: make sure section depths are consecutive
skipping heading levels (eg from # to ###, or starting at ###) is legal
in pandoc, but not in nixos-render-docs. pandoc acts as though section
levels *were* consecutive, nixos-render-docs prefers to tell people not
to do that kind of thing because it can make documents more fragile.
2023-06-10 18:17:04 +02:00
pennae
830f5b33dd doc: add missing section IDs 2023-06-10 18:17:04 +02:00
7c6f434c
e4d2ceab3d
Merge pull request #234201 from 7c6f434c/fix-untagged-version
coding-conventions: include the preceding upstream version
2023-06-08 14:36:01 +00:00
Basile Clément
66f57b6c18
Improve fetchFromGitLab manual (#236111)
* doc/builders: update fetchers documentation

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-06-07 10:51:48 +02:00
Julian Arni
858583a958
doc/language-frameworks/haskell: fix argument order of setBuildTargets (#236252) 2023-06-06 18:28:23 +02:00
figsoda
2bfb2f045a pypi2nix: remove
It has been broken since 2021 and upstream has been archived
2023-06-03 16:44:43 +02:00
Michael Raskin
5b90f7a6a9 coding-conventions: include the preceding upstream version when packaging a commit without a version attached 2023-06-02 13:27:25 +02:00
Alyssa Ross
caa0a24ab0 doc: clarify that meta.timeout is only for Hydra
I read this and expected it to be a timeout that was always applied
when building the derivation, but it's actually a Hydra-specific
thing.
2023-05-30 10:27:44 +00:00
github-actions[bot]
53e76520b9
Merge master into haskell-updates 2023-05-28 00:14:04 +00:00
Yueh-Shun Li
48c5962048 doc/language-frameworks/go.section.md: fix spelling
Change "platform dependant" to "platform-dependent"

The word "dependant" (with suffix -ant) is used as a noun
in British English, while the adjetive is "dependent" (-ent).
Both are "dependent" in American English.

Reference:
https://www.merriam-webster.com/words-at-play/spelling-variants-dependent-vs-dependant
https://dictionary.cambridge.org/dictionary/english/dependant
2023-05-28 07:50:02 +10:00
github-actions[bot]
490b8d0c9a
Merge master into haskell-updates 2023-05-27 00:13:30 +00:00
Rebecca Turner
ec2938bfa5
Document incremental build support for Haskell 2023-05-25 14:36:18 -07:00
Rebecca Turner
33258207fa
maintainers: Gabriel439 -> Gabriella439 2023-05-25 14:35:51 -07:00
Connor Baker
222d966273 cudaPackages.cudnn: remove patch version from name to conform with cudaPackages standard 2023-05-24 12:56:22 -04:00
Atemu
3009b12817 doc:fhs-envs: reword 2023-05-22 11:34:04 -03:00
Atemu
e57efc6cb7 doc:fhs-envs: format example properly
That sort of formatting wouldn't be accepted into Nixpkgs. We shouldn't format
an example like that.
2023-05-22 11:34:04 -03:00
Atemu
8912c50fc7 doc:fhs-envs: mention that runScript must be escaped by the caller 2023-05-22 11:34:04 -03:00
figsoda
999652eb33 doc/python: remove usages of fetchPypi aliases 2023-05-21 11:28:13 -04:00
Nicolas Benes
142c24711e doc: fix typo 2023-05-20 22:09:52 +02:00
Martin Weinelt
b0a993e6ba
Merge pull request #232594 from mweinelt/python-docs
doc/languages-frameworks/python: update formatting and interpreters
2023-05-20 21:02:31 +02:00
Martin Weinelt
35650d8be3
doc/languages-frameworks/python: update formatting and interpreters
Updates all interpreter references with 3.10/3.11, which are the
current version, that we recurse into for their package set.

Update all code examples with an explicit `format` and expand lists
with multiple items as we do in the python package set. Also set
`pythonImportsCheck` where tests are disabled.
2023-05-20 03:31:35 +02:00
Jan Tojnar
8bf1967964 doc/stdenv/Dependencies: fix inference rule var name
t0 is mentioned in the conclusion so we cannot use placeholder in the premise.
2023-05-18 18:10:10 +02:00
Alyssa Ross
5e06b3cb19 treewide: don't use rustPlatform.rust
This will be deprecated in the next commit.
2023-05-12 15:31:21 +00:00
Jacek Galowicz
cc8e4ed375
Merge pull request #225313 from hercules-ci/testers-runNixOSTest
testers.runNixOSTest: init
2023-05-12 16:04:26 +02:00
Kira Bruneau
d4652d33d6
Merge pull request #229770 from Misterio77/init-buildDartPackage
buildDartApplication: init
2023-05-11 14:43:20 -04:00
Robert Hensing
ac1134f321 testers.runNixOSTest: init
An up to date alternative to pkgs.nixosTest
2023-05-11 19:12:07 +02:00
Weijia Wang
ee5b4b9d52
Merge pull request #231112 from farnoy/shortenPerlShebangs-manual-buildInputs
doc: update shortenPerlShebang example to use nativeBuildInputs
2023-05-10 22:38:11 +03:00
Hraban Luyat
7282c4012d docs: typo in cuda docs, forgot a colon (:) 2023-05-10 14:32:27 -04:00
Jakub Okoński
9948a0d6c9
doc: update shortenPerlShebang example to use nativeBuildInputs 2023-05-10 18:34:17 +02:00
Robert Hensing
216315c6c4
Merge pull request #197547 from hercules-ci/module-class-and-flake-import
module system: Improve error messages around faulty imports
2023-05-06 20:16:34 +02:00
figsoda
955f4f6512
Merge pull request #230177 from SuperSandro2000/lib-fromJSON-2
treewide: switch builtins.fromJSON(builtins.readFile ./file.json) to …
2023-05-06 14:12:43 -04:00
Robert Hensing
eab660d91e lib.modules: configurationClass -> class
This simplifies the documentation. `configuration` is implied by `_type`.
2023-05-06 18:32:59 +02:00
Robert Hensing
89491bef8d lib.modules: in evalModules return move _module.class -> configurationClass 2023-05-06 18:32:59 +02:00
Robert Hensing
4c7aa7d831 doc/module-system: _module is not internal 2023-05-06 18:32:59 +02:00
Robert Hensing
fd88c79418 lib.modules: Change class declaration in module to _class 2023-05-06 18:32:59 +02:00
Robert Hensing
8054785157 lib/modules: Move class out of specialArgs 2023-05-06 18:32:58 +02:00
Robert Hensing
8f02e95aff module-system.chapter.md: Elaborate on extendModules performance 2023-05-06 18:32:58 +02:00
Robert Hensing
5fac39307d module-system.chapter.md: Add mental model to type and extendModules 2023-05-06 18:32:58 +02:00
Robert Hensing
03a465f048 fixup! doc: Add Module System chapter start 2023-05-06 18:32:12 +02:00
Robert Hensing
ee1e14be0c doc: Add Module System chapter start 2023-05-06 18:29:05 +02:00
Robert Hensing
79703eef08 nixos,nixpkgs: Add module classes
This allows modules that declare their class to be checked.
While that's not most user modules, frameworks can take advantage
of this by setting declaring the module class for their users.
That way, the mistake of importing a module into the wrong hierarchy
can be reported more clearly in some cases.
2023-05-06 18:29:04 +02:00
Sandro Jäckel
00000001b4
treewide: switch builtins.fromJSON(builtins.readFile ./file.json) to lib.importJSON ./file.json #2 2023-05-06 16:20:13 +02:00
Et7f3
caf436a52b ocamlPackages.buildDunePackage: deprecate useDune2 2023-05-06 08:11:25 +02:00
Gabriel Fontes
d161ef5631
buildFlutterApplication: add docs 2023-05-05 13:32:50 -03:00
Gabriel Fontes
782c8b44dd
buildDartApplication: init
This adds a function for easily packaging non-flutter dart apps.
2023-05-05 13:32:45 -03:00
Adam Joseph
ed312cb4f7
doc/default.nix: make the manual build on more than one core (#225921)
* doc/default.nix: make the manual build on more than one core

Let's build the manual with more than one core.  Maybe people will take better care of it now that it is less painful to build.
2023-04-25 14:37:50 +02:00
Sandro Jäckel
aad577bd30 nodejs*: normalise names to better fit other packages
Versioned package attributes are usually named like $pname_$version
eg: nodejs-14_x -> nodejs_14
2023-04-25 11:28:17 +02:00
Adam Joseph
372e0f8efc
doc/stdenv/meta.chapter.md: document meta.badPlatforms (#225276)
* doc/stdenv/meta.chapter.md: document meta.badPlatforms

We don't have any documentation for the `meta.badPlatforms` attribute.

This commit adds documentation for it.
2023-04-24 10:06:50 +02:00