summaryrefslogtreecommitdiff
path: root/doc/doc-support (follow)
Commit message (Expand)AuthorAgeFilesLines
* doc: autogenerate python interpreter table (#313408)•••* doc: autogenerate python interpreter table This serves as a practical example on generating documentation by inspection of the evaluated Nixpkgs tree. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>Alejandro Sánchez Medina2024-05-231-0/+63
* adds block_args for autogenerated ids from trustworthy sourcesJohannes Kirschbauer2024-01-291-1/+1
* doc: Render lib.fixedPointsRobert Hensing2023-07-081-7/+10
* doc: inline doc-support to main drv•••separating function docs out like this makes it less clear how library documentation is generated and integrated into the build. if in the future more parts of nixpkgs use nixdoc it will make sense to have all information about library doc generation in the same place. pennae2023-07-011-28/+0
* doc: pull option docs out of doc-support•••this leaves doc-support as a simple wrapper around function docs. this wrapper will go away very soon as well. pennae2023-07-011-27/+0
* doc: remove remnants of docbook times•••all xml-related tooling can go away. shell.nix is no longer useful since the makefile is gone and the build runs entirely via a derivation, and gitignore is thus also no longer that useful. it may filter out some swap files, but its main reason to exist (keeping generated files out of a concurrent build of the derivation) has gone away. pennae2023-07-013-118/+0
* doc: render nixpkgs manual with nrd•••also updates nixdoc to 2.3.0. the nixdoc update is not a separate commit because that would leave the manual build broken for one commit, potentially breaking bisects and rebases. pennae2023-07-013-38/+22
* doc-support: don't expose locationsXml•••nothing except function docs uses this, so we need not expose it. we'll be reworking this entire section of the build anyway, with the target of breaking up doc-support as it is now. pennae2023-07-012-5/+8
* lib/modules: Move class out of specialArgsRobert Hensing2023-05-061-1/+1
* 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. Robert Hensing2023-05-061-1/+4
* doc: Fix the function locations always pointing to master•••Instead of revisions as they should. This is (most-likely) caused by a simple typo, because Hydra is where the revision should come from, but it doesn't set `.revision` as the attribute, but rather `.rev`! Silvan Mosberger2023-04-131-1/+1
* nixos/manual: remove holdovers from docbook times•••these files provided mainly or exclusively xml-related tooling and support for editing the manual. since docbook is now an implementation detail (except for still being allowed in option docs, for now) these tools are no longer necessary, useful, or even functional. xmlformat.conf is still used by the nixpkgs documentation, so we have to keep it. there's no reason it can't go live with the nixpkgs docs though. pennae2023-02-122-1/+73
* lib.path.subpath.isValid: init•••The first path library function Silvan Mosberger2023-01-031-0/+1
* lib: Allow doc rendering for lib/<name>/default.nixSilvan Mosberger2022-12-231-1/+5
* lib: correctly render docs for nested identifiers•••Applies https://github.com/nix-community/nixdoc/pull/27 and fixes up the location information rendering, allowing lib functions to be nested in further scopes Needed for later commits Silvan Mosberger2022-12-231-7/+9
* doc/lib-functions: print libset name before descriptionNaïm Favier2022-12-222-11/+12
* doc/lib-functions: preserve libsets orderNaïm Favier2022-12-223-16/+16
* doc/lib-functions: add `versions`, `cli`Naïm Favier2022-12-221-0/+2
* doc/lib-functions: remove warnings•••Building the nixpkgs manual currently triggers a bunch of deprecation warnings, because every attribute in `lib` is evaluated to see if it's an attrset to generate locations for. Instead, share the lib subsets to include in the documentation between `lib-function-docs` and `lib-function-locations` so they can coordinate. Also generate the list of sections instead of duplicating it in `library.xml`. Naïm Favier2022-12-224-23/+35
* doc: fix typosfigsoda2022-12-171-1/+1
* doc: Remove all section numbers•••Simplicity. We use anchors nowadays. Nobody should be printing this. Robert Hensing2022-12-121-3/+6
* doc: auto-generate asserts and attrset library docs•••If all the docs are auto-generated, it should be easier to convert them to Commonmark. Co-Authored-By: Valentin Gagarin <valentin.gagarin@tweag.io> Co-Authored-By: Silvan Mosberger <contact@infinisil.com> Ryan Mulligan2022-12-081-0/+2
* Revert "lib,doc: remove obvious usages of toString on paths"Anderson Torres2022-11-051-1/+1
* lib,doc: remove obvious usages of toString on paths•••It gives a warning on the lazy-trees branch of Nix (NixOS/nix#6530) one of these was also giving me an error (the one in lib/trivial probably) ``` $ nix build warning: applying 'toString' to path '/home/artturin/nixgits/my-nixpkgs/nixos/modules/installer/sd-card/sd -image-aarch64.nix' and then accessing it is deprecated, at /home/artturin/nixgits/my-nixpkgs/lib/modules. nix:349:99 warning: applying 'toString' to path '/home/artturin/nixgits/my-nixpkgs/.git' and then accessing it is dep recated, at /home/artturin/nixgits/my-nixpkgs/lib/sources.nix:35:32 warning: applying 'toString' to path '/home/artturin/nixgits/my-nixpkgs/nixos/modules/system/etc/etc.nix' and then accessing it is deprecated, at «stdin»:0 warning: applying 'toString' to path '/home/artturin/nixgits/my-nixpkgs/nixos/modules/system/etc/etc-activ ation.nix' and then accessing it is deprecated, at «stdin»:0 warning: applying 'toString' to path '/home/artturin/nixgits/my-nixpkgs/nixos/modules/installer/sd-card/sd -image-aarch64.nix' and then accessing it is deprecated, at «stdin»:0 error: cannot decode virtual path '/nix/store/virtual0000000000000000000000005-source' (use '--show-trace' to show detailed location information) ``` Artturin2022-11-061-1/+1
* lib: Automatically generate lib.filesytem docsSilvan Mosberger2022-10-261-0/+1
* nixpkgs/doc: generate consistent docbook ids•••to make diff'ing different versions of the generated docs less noisy Arnout Engelen2022-07-281-0/+1
* doc: Fix config options reference file linksRobert Hensing2022-06-151-0/+15
* doc: Add Nixpkgs config options referenceRobert Hensing2022-05-021-0/+9
* lib.sources: Generate docsRobert Hensing2021-05-291-0/+1
* Revert "make-tarball.nix: Restore the 'commit' field in packages.json"•••This reverts commit 5e8545e72341887bb371407a71a723bc0e9c7844. It breaks eval: attribute 'rev' missing, at /var/lib/ofborg/checkout/repo/38dca4e3aa6bca43ea96d2fcc04e8229/mr-est/eval-0-gleber.ewr1.nix.ci/pkgs/top-level/make-tarball.nix:106:39 Florian Klink2020-03-291-1/+1
* make-tarball.nix: Restore the 'commit' field in packages.json•••Also change incorrect 'revision' to 'rev' in the default value for 'nixpkgs' in release.nix. Fixes https://github.com/NixOS/nixos-homepage/issues/372. Eelco Dolstra2020-03-291-1/+1
* doc: organize chapters into parts, and reduce toc depth•••Reorganize the chapters into parts and reduce the TOC depth to make the TOC useful again. The top-level TOC is very brief, but that is fine because every part will have its own TOC. Section titles of languages/frameworks are also simplified to just the name of the language/framework. Frederik Rietdijk2019-10-201-1/+1
* treewide: remove redundant quotesvolth2019-08-261-2/+2
* doc: move parameters to an XML fileGraham Christensen2019-07-042-0/+36
* xmlformat.conf: move to doc-support buildGraham Christensen2019-07-041-0/+1
* docs: Get highlightjs from build symlinkGraham Christensen2019-07-041-0/+2
* docs: get XSL from build / symlinkGraham Christensen2019-07-041-0/+1
* docs: find docbook rng from doc-supportGraham Christensen2019-07-041-0/+3
* docs: get version from doc-support buildGraham Christensen2019-07-041-0/+2
* docs: use a single nix-build for all the generate function docsGraham Christensen2019-07-043-0/+125