summaryrefslogtreecommitdiff
path: root/doc/default.nix (follow)
Commit message (Expand)AuthorAgeFilesLines
* workflows/manual-nixpkgs: build nixpkgs manual on staging and stable branches•••By using the pinned nixpkgs we have for CI, we can lift the restriction of building the nixpkgs manual only in PRs targeting master. At the same time, this uses the pinned nixpkgs for the doc/ folder's dev shell. This allows entering that shell while working on a staging-based branch and write documentation. Why should staging be un(der)documented, after all? Note: The package that is available in nixpkgs as pkgs.nixpkgs-manual will still be built with the current nixpkgs checkout, not the pinned version. This is the same that hydra builds. Wolfgang Walther2025-05-291-2/+2
* nixpkgs-manual: initPhilip Taron2024-07-261-1/+1
* doc: extract nixpkgs-manual into its own package•••Also, use `finalAttrs` style and pass through all the helper derivations. Philip Taron2024-07-261-97/+5
* doc: extract manpage-urls test into its own packagePhilip Taron2024-07-261-21/+1
* doc: reshape python-interpreter-table.nix into a normal callPackage•••Before, it produced a string, not a derivation. Philip Taron2024-07-261-6/+8
* doc: extract optionsDoc into its own packagePhilip Taron2024-07-261-22/+3
* doc: extract epub manual stub into its own packagePhilip Taron2024-07-261-41/+1
* doc: make ./doc-support/lib-function-docs.nix callPackage style•••Move `libsets` over to it, since it's the only user. Format with `nixfmt` since we're changing it so dramatically. Philip Taron2024-07-261-24/+3
* docs: $TMP -> $TMPDIR in Darwin build•••`TMPDIR` is the canonical form in POSIX and SUS https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html#tag_08_03 Valentin Gagarin2024-07-131-2/+2
* docs: allow building in sandbox on darwin•••For whatever reason `zip` in this case doesn't seem to be respecting the `$TMP` or `$TMPDIR` variables, resulting in a permission denied error on Darwin when sandbox is enabled. The `-b` flag allows one to manually specify a tempdir, which allows the build to succeed in spite of sandboxing. Fixes https://github.com/NixOS/nixpkgs/issues/326380 Nathan Henrie2024-07-131-2/+2
* Merge pull request #312407 from hsjobeki/doc/lib-generators•••doc: init lib.generators reference documentationSilvan Mosberger2024-06-261-0/+1
|\
| * doc: init lib.generators reference documentationJohannes Kirschbauer2024-05-211-0/+1
* | doc: Prevent unnecessary rebuilds•••Especially when only Nix files are changed Silvan Mosberger2024-06-151-1/+14
* | doc: Use build-time to insert dynamic python interpreter table•••Nix eval isn't made to patch stuff, it's more flexible to do it at build time Silvan Mosberger2024-06-151-8/+6
* | 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-1/+9
|/
* doc: Use substitute --replace-fail in manuals•••This fixes a warning about --replace being deprecated. Jan Tojnar2024-05-021-1/+1
* doc: fix and simplify stylesheets for the manuals, fix nrd bug (#295847)•••* doc: fix and simplify stylesheets for the manuals, fix nrd bug * Add anchorjs script to add links on section headers * Fix another nrd bug, address style changes * Use span instead of a for inline span syntaxDaniel Sidhion2024-03-161-2/+3
* lib: Add optionalDrvAttr to conditionally set drv attributes.•••This allows for adding new, conditionally set, derivation attributes to an existing derivation without changing any output paths in the case where the condition is not met. Shea Levy2024-02-021-0/+1
* doc: Add test for broken links in `manpage-urls.json`nicoo2023-12-181-0/+22
* doc: Add lib.meta to the library functions ToC•••This seems like a pretty easy-to-fix oversight, and it documents the getExe function, which I never knew about until one day I saw a PR using it. Let's include it in the manual. Andreas Fuchs2023-11-041-0/+1
* doc: generate documentation for lib.customisationYueh-Shun Li2023-10-201-0/+1
* Merge pull request #245623 from tweag/fileset.toSource•••File set combinators base: `lib.fileset.toSource`Silvan Mosberger2023-09-021-0/+1
|\
| * lib.fileset.toSource: initSilvan Mosberger2023-09-011-0/+1
* | lib/gvariant: initlinsui2023-08-151-0/+1
|/
* nixpkgs manual: extract some build paths•••Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com> Alejandro Sanchez Medina2023-07-251-3/+5
* doc: Render lib.fixedPointsRobert Hensing2023-07-081-0/+1
* 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-3/+18
* 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-0/+26
* 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-011-1/+1
* 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-011-14/+33
* doc: build placeholder epub in its own derivation•••mostly to clean up the main manual build makefile and derivation a bit. not technically necessary, but will make life easier later. pennae2023-07-011-27/+43
* doc: stub out epub manual•••same reasoning as for the nixos manual. pennae2023-06-121-0/+26
* 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.Adam Joseph2023-04-251-0/+4
* doc: use `gitignoreSource`•••Running `make -C doc` to build the manual locally leaves .xml artifacts in the tree. These are ignored by git, but they still get included in the build when not using flakes, which causes the corresponding chapters not to be built. Naïm Favier2023-02-071-2/+1
* doc: separate manpage URLs from the Pandoc filter•••Move the manpage-to-URL mapping to `doc/manpage-urls.json` so that we can reuse that file elsewhere, and generate the `link-manpages.lua` filter from that file. Also modify the Pandoc filter so that it doesn't wrap manpages that are already inside a link. Keeping a Lua filter is essential for speed: a Python filter would increase the runtime `md-to-db.sh` from ~20s to ~30s (but Python is not to blame; marshalling Pandoc types to and from JSON is a costly operation). Parsing in Lua seems tedious, so I went with the Nix way. Naïm Favier2023-01-021-0/+1
* doc: Fix make in nix-shell•••When running make manually, makeFlags will not be passed. Let’s just use an environment variable. Jan Tojnar2021-06-051-4/+3
* doc: use lib.cleanSource•••Otherwise, running "nix-build" in the doc directory would create a result symlink, so running "nix-build" again would produce a different derivation, and so on forever, because the result symlink would keep changing and wasn't ignored. Alyssa Ross2021-02-121-1/+1
* doc: Add staging workflow diagramJan Tojnar2020-12-091-1/+13
* doc: move parameters to an XML fileGraham Christensen2019-07-041-15/+0
* xmlformat.conf: move to doc-support buildGraham Christensen2019-07-041-1/+0
* docs: Get highlightjs from build symlinkGraham Christensen2019-07-041-1/+0
* docs: get XSL from build / symlinkGraham Christensen2019-07-041-1/+0
* docs: find docbook rng from doc-supportGraham Christensen2019-07-041-1/+0
* docs: get version from doc-support buildGraham Christensen2019-07-041-1/+1
* docs: use a single nix-build for all the generate function docsGraham Christensen2019-07-041-5/+1
* doc: Add automatic generation of library function documentation•••Modifies the build process of the manual to invoke nixdoc automatically to generate XML files with function documentation. Currently documentation is present for five of the files in `lib/`. To add another file to the generated docs, both `doc/functions/library.xml` and `doc/lib-function-docs.nix` must be updated. Vincent Ambo2019-01-041-2/+3
* Generate links to function definitions•••Hydra passes the full revision in to the input, which we pass through. If we don't get this ,we try to get it from other sources, or default to master which should have the definition in a close-ish location. All published docs should have theURL resolve properly, only local hackers will have the link break. Graham Christensen2018-10-051-1/+4
* Merge pull request #43857 from volth/unused•••[bot] treewide: remove unreferenced codeFrederik Rietdijk2018-07-201-2/+0
|\
| * [bot]: remove unreferenced codevolth2018-07-201-2/+0
* | treewide: remove aliases in nixpkgs•••This makes the command ‘nix-env -qa -f. --arg config '{skipAliases = true;}'’ work in Nixpkgs. Misc... - qtikz: use libsForQt5.callPackage This ensures we get the right poppler. - rewrites: docbook5_xsl -> docbook_xsl_ns docbook_xml_xslt -> docbook_xsl diffpdf: fixup Matthew Bauer2018-07-181-1/+1
|/