summaryrefslogtreecommitdiff
path: root/modules/documentation
AgeCommit message (Collapse)Author
2024-06-13Reapply "eval-config: set `class`"Emily
All supported Nixpkgs versions now support this. This reverts commit a5b09580e2d0bbc52b338afe4f1f1d46178e6bbf.
2024-06-13treewide: remove shims for Nixpkgs ≤ 23.05Emily
These deprecated versions were already made unsupported by #932.
2024-04-19treewide: remove lib.mdDocWeijia Wang
2023-07-24Revert "eval-config: set `class`"Emily
2023-07-21documentation: use `eval-config.nix`Emily
Avoid letting the module evaluation for the documentation drift out of sync with how system configurations are evaluated.
2023-07-09version: default Git revision options to `null`Emily
This allows for more uniform handling in the documentation generator, and avoids lying about the Git reference being `master` internally.
2023-07-08documentation: use feature test for docs generatorEmily
This should be less brittle than the version-based check, although arguably this kind of `lib.version` mismatch should break as early as possible... Fixes: #718
2023-06-30documentation: Link to nixpkgs master if rev is unknownRobert Hensing
This fixes error: The option `system.nixpkgsRevision' is used but not defined.
2023-06-24doc/manual: use `nixos-render-docs`Emily
Now that all the DocBook documentation is gone, we can switch to the new NixOS documentation generator. No meaningful change in HTML output, except that I removed the rather pointless preface and changed the title accordingly. Manual page output is greatly improved; it was kind of broken before. The `sed` hack is pretty gross but I have confirmed that nixpkgs will be happy to accept a PR to make things a little more customizable. This also drops the `manual` alias (deprecated in nixpkgs in 2018 and imported into nix-darwin), and `manualEpub` (because the NixOS documentation generator doesn't support it and also nobody wants this as an ebook).
2023-06-24treewide: convert all option docs to MarkdownEmily
This process was automated by [my fork of `nix-doc-munge`]; thanks to @pennae for writing this tool! It automatically checks that the resulting documentation doesn't change, although my fork loosens this a little to ignore some irrelevant whitespace and typographical differences. As of this commit there is no DocBook remaining in the options documentation. You can play along at home if you want to reproduce this commit: $ NIX_PATH=nixpkgs=flake:nixpkgs/c1bca7fe84c646cfd4ebf3482c0e6317a0b13f22 \ nix shell nixpkgs#coreutils \ -c find . -name '*.nix' \ -exec nix run github:emilazy/nix-doc-munge/0a7190f600027bf7baf6cb7139e4d69ac2f51062 \ {} + [my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge
2023-06-24doc/manual: use `nixosOptionDoc`Emily
The only change to `options.json` are that the `declarations` fields now contain correct GitHub URLs. The changes to the HTML manual are all either strict improvements: * "Declared by:" links point to the correct URLs. * `lib.mdDoc` documentation is included. or else trivial: * Additional whitespace in the HTML source. * Some interchange of `<pre class="programlisting">` and `<code class="literal">`. * Fancy quotes used in some type descriptions. `optionsDocBook` is exported temporarily as it is used by `nix-doc-munge` for the Markdown conversion process. This drops support for building the manual on 22.11, which lacks a complete implementation of this processor, and provides stubbed-out manual packages with an explanation on that version.
2022-01-02modules/documentation/default.nix: Fix args warningRobert Hensing
2020-08-16documentation: Don't set localSystem which doesn't existRobert Hensing
This is safe to remove, because it is not referenced anywhere in nix-darwin. It should have been discovered way earlier, but a bug in the module system has allowed this value to be defined until https://github.com/NixOS/nixpkgs/commit/fd75dc876586bde8cdb683a6952a41132e8db166
2019-05-04doc: fix module referencesDaiderd Jordan
2019-05-04version: include darwin metadata in system labelDaiderd Jordan
This makes it possible to trace back what version of both darwin and nixpkgs the system was built with.
2019-05-04documentation: add module for darwin manualDaiderd Jordan
Fixes #72