about summary refs log tree commit diff
path: root/doc/default.nix
AgeCommit message (Collapse)AuthorFilesLines
4 daysdocs: $TMP -> $TMPDIR in Darwin buildValentin Gagarin1-2/+2
`TMPDIR` is the canonical form in POSIX and SUS https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html#tag_08_03
4 daysdocs: allow building in sandbox on darwinNathan Henrie1-2/+2
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
2024-06-26Merge pull request #312407 from hsjobeki/doc/lib-generatorsSilvan Mosberger1-0/+1
doc: init lib.generators reference documentation
2024-06-15doc: Prevent unnecessary rebuildsSilvan Mosberger1-1/+14
Especially when only Nix files are changed
2024-06-15doc: Use build-time to insert dynamic python interpreter tableSilvan Mosberger1-8/+6
Nix eval isn't made to patch stuff, it's more flexible to do it at build time
2024-05-23doc: autogenerate python interpreter table (#313408)Alejandro Sánchez Medina1-1/+9
* 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>
2024-05-21doc: init lib.generators reference documentationJohannes Kirschbauer1-0/+1
2024-05-02doc: Use substitute --replace-fail in manualsJan Tojnar1-1/+1
This fixes a warning about --replace being deprecated.
2024-03-16doc: fix and simplify stylesheets for the manuals, fix nrd bug (#295847)Daniel Sidhion1-2/+3
* 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 syntax
2024-02-02lib: Add optionalDrvAttr to conditionally set drv attributes.Shea Levy1-0/+1
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.
2023-12-18doc: Add test for broken links in `manpage-urls.json`nicoo1-0/+22
2023-11-04doc: Add lib.meta to the library functions ToCAndreas Fuchs1-0/+1
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.
2023-10-20doc: generate documentation for lib.customisationYueh-Shun Li1-0/+1
2023-09-02Merge pull request #245623 from tweag/fileset.toSourceSilvan Mosberger1-0/+1
File set combinators base: `lib.fileset.toSource`
2023-09-01lib.fileset.toSource: initSilvan Mosberger1-0/+1
2023-08-15lib/gvariant: initlinsui1-0/+1
2023-07-25nixpkgs manual: extract some build pathsAlejandro Sanchez Medina1-3/+5
Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com>
2023-07-08doc: Render lib.fixedPointsRobert Hensing1-0/+1
2023-07-01doc: inline doc-support to main drvpennae1-3/+18
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.
2023-07-01doc: pull option docs out of doc-supportpennae1-0/+26
this leaves doc-support as a simple wrapper around function docs. this wrapper will go away very soon as well.
2023-07-01doc: remove remnants of docbook timespennae1-1/+1
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.
2023-07-01doc: render nixpkgs manual with nrdpennae1-14/+33
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.
2023-07-01doc: build placeholder epub in its own derivationpennae1-27/+43
mostly to clean up the main manual build makefile and derivation a bit. not technically necessary, but will make life easier later.
2023-06-12doc: stub out epub manualpennae1-0/+26
same reasoning as for the nixos manual.
2023-04-25doc/default.nix: make the manual build on more than one core (#225921)Adam Joseph1-0/+4
* 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-02-07doc: use `gitignoreSource`Naïm Favier1-2/+1
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.
2023-01-02doc: separate manpage URLs from the Pandoc filterNaïm Favier1-0/+1
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.
2021-06-05doc: Fix make in nix-shellJan Tojnar1-4/+3
When running make manually, makeFlags will not be passed. Let’s just use an environment variable.
2021-02-12doc: use lib.cleanSourceAlyssa Ross1-1/+1
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.
2020-12-09doc: Add staging workflow diagramJan Tojnar1-1/+13
2019-07-04doc: move parameters to an XML fileGraham Christensen1-15/+0
2019-07-04xmlformat.conf: move to doc-support buildGraham Christensen1-1/+0
2019-07-04docs: Get highlightjs from build symlinkGraham Christensen1-1/+0
2019-07-04docs: get XSL from build / symlinkGraham Christensen1-1/+0
2019-07-04docs: find docbook rng from doc-supportGraham Christensen1-1/+0
2019-07-04docs: get version from doc-support buildGraham Christensen1-1/+1
2019-07-04docs: use a single nix-build for all the generate function docsGraham Christensen1-5/+1
2019-01-04doc: Add automatic generation of library function documentationVincent Ambo1-2/+3
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.
2018-10-05Generate links to function definitionsGraham Christensen1-1/+4
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.
2018-07-20Merge pull request #43857 from volth/unusedFrederik Rietdijk1-2/+0
[bot] treewide: remove unreferenced code
2018-07-20[bot]: remove unreferenced codevolth1-2/+0
2018-07-18treewide: remove aliases in nixpkgsMatthew Bauer1-1/+1
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
2018-06-06manual: make epub a build product on hydra (#41475)Daiderd Jordan1-0/+1
2018-04-30nixpkgs doc: add format Make targetGraham Christensen1-1/+2
2018-04-28treewide: rename version attributesMaximilian Bosch1-1/+1
As suggested in https://github.com/NixOS/nixpkgs/pull/39416#discussion_r183845745 the versioning attributes in `lib` should be consistent to `nixos/version` which implicates the following changes: * `lib.trivial.version` -> `lib.trivial.release` * `lib.trivial.suffix` -> `lib.trivial.versionSuffix` * `lib.nixpkgsVersion` -> `lib.version` As `lib.nixpkgsVersion` is referenced several times in `NixOS/nixpkgs`, `NixOS/nix` and probably several user's setups. As the rename will cause a notable impact it's better to keep `lib.nixpkgsVersion` as alias with a warning yielded by `builtins.trace`.
2018-03-26nixpkgs docs: syntax highlightGraham Christensen1-1/+7
2018-03-26Move the overridden CSS to overrides.css which can be applied on nixos.orgGraham Christensen1-1/+1
2018-03-26nixpkgs docs: Use SVGs for calloutsGraham Christensen1-3/+3
2018-03-25Validate when building outputsGraham Christensen1-1/+1
2018-03-25docs: Build with a makefileGraham Christensen1-105/+24