about summary refs log tree commit diff
path: root/doc/Makefile
AgeCommit message (Collapse)AuthorFilesLines
2021-07-13doc: Add helper for converting DocBook files to MarkdownJan Tojnar1-1/+1
2021-07-13doc: Linkify man page referencesJan Tojnar1-0/+1
2021-07-13doc: Add support for MyST rolesJan Tojnar1-0/+4
Officially, only the manpage role is supported at the moment. Unlike in rST, the syntax uses braces instead of colons: {manpage}`nix.conf(5)`
2021-07-12doc: Move lua filters to subdirectoryJan Tojnar1-1/+1
2021-06-18nixos/doc: Synchronize the Markdown generator with NixpkgsJan Tojnar1-2/+3
Switch to CommonMark with our extensions.
2021-06-12Merge pull request #125671 from SFrijters/doc-improve-make-cleanRyan Mulligan1-1/+1
doc: Clean up generated media directory
2021-06-07doc: Use markdown syntax for xrefsJan Tojnar1-0/+1
Syntax is taken from MyST: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
2021-06-07doc: Build as CommonMarkJan Tojnar1-10/+15
We were using Pandoc’s Markdown parser. This is non-standard and might cause issues when we finally switch to some other tool. Since RFC 0072 agreed on CommonMark, let’s switch to that. We will use some extensions to make the limited syntax bearable but these are official so they should be more portable.
2021-06-04doc: Clean up generated media directoryStefan Frijters1-1/+1
pandoc uses ./media to extract media files - add it to the list of directories that need to be removed by `make clean`.
2021-03-04doc/README.md: initRobert Hensing1-1/+1
2020-12-09doc: Add staging workflow diagramJan Tojnar1-0/+6
2020-12-07doc: clean up makefileJan Tojnar1-14/+2
The sectn and ulink hacks are not necessary since pandoc has been defaulting to Docbook 5 for a long time. With the pandoc patches, we can get rid of id→xml:id replacement and xmlns hacks as well.
2020-07-18doc: fix MD_TARGETSMitsuhiro Nakamura1-1/+1
globstar (**) does not work in Makefile
2020-03-02nixpkgs manual: fix build after pandoc(?) updateVladimír Čunát1-2/+2
I din't try to pinpoint the exact commit, but we started getting: > The extension smart is not supported for docbook Reading pandoc docs, I can't see what use to us "smart" could be when writing the in-between docbook (to be converted to html). https://pandoc.org/MANUAL.html#extension-smart
2019-07-04doc: move parameters to an XML fileGraham Christensen1-4/+4
2019-07-04xmlformat.conf: move to doc-support buildGraham Christensen1-2/+2
2019-07-04docs: Get highlightjs from build symlinkGraham Christensen1-5/+5
2019-07-04docs: get XSL from build / symlinkGraham Christensen1-5/+5
2019-07-04docs: find docbook rng from doc-supportGraham Christensen1-2/+2
2019-07-04docs: get version from doc-support buildGraham Christensen1-4/+3
2019-07-04docs: use a single nix-build for all the generate function docsGraham Christensen1-8/+8
2019-03-24manual: Make sure building doesn't need recursive nixJohn Ericson1-6/+5
$(shell ...) looks a little sketch like it will be run no matter what. And there are problems building the manual on darwin so hopefully this fixes them.
2019-02-01doc: Include function doc generation in MakefileVincent Ambo1-4/+10
Since #53055 was merged the Makefile for the manual could not be run correctly as the generated function documentation was included, but not actually generated. This adds the necessary generation step by first building the XML file containing function locations and preserving its store path in a variable, which is then used both for linking of the locations file and as a build input for the function docs generator. This fixes #55014
2019-01-11manual: document ways of obtaining source hashesdanbst1-2/+4
... and security nuances
2018-10-05Generate links to function definitionsGraham Christensen1-2/+6
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-10-05nixpkgs: Start documenting library functions in XMLGraham Christensen1-1/+1
Covers assert functions and about half of the attrsets functions. Some internal consistency around IDs could be improved.
2018-10-02nixpkgs docs: Rebuild manual-full if nested XML docs changeGraham Christensen1-1/+1
2018-05-31doc: Adds xml fixing script. (see previous and next commits)Samuel Dionne-Riel1-0/+5
This script is used to automatically fix issues within xml documentation files. The script is *for now* intended to be used ad-hoc, and the commits to be examined. A future discussion will define whether: * This commit and scripts are kept. * The script is extended for common use. The biggest issue right now with the script is that it *could* in theory destroy a valid space-less varlistentry. The script could, in practical use, be changed and extended to normalize some parts of the XML files, mainly: * A common quoting style for attributes * Fix-up some weird formatting automatically that xmlformat doesn't catch
2018-04-30nixpkgs doc: add format Make targetGraham Christensen1-1/+6
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-04-05nixos docs: syntax highlightGraham Christensen1-7/+1
- Rectifies diverging CSS by combining nixos/nixpkgs docs CSS - Moves our custom Highlight.js loader in to the hljs package - Switches the nixos docs to use SVG callouts too
2018-03-26nixpkgs docs: syntax highlightGraham Christensen1-3/+21
2018-03-26Move the overridden CSS to overrides.css which can be applied on nixos.orgGraham Christensen1-0/+2
2018-03-26nixpkgs docs: Use SVGs for calloutsGraham Christensen1-4/+6
2018-03-25Add 'make debug' to call xmloscopyGraham Christensen1-0/+3
2018-03-25Move validate to top-level so it doesn't rebuild the outputs every timeGraham Christensen1-3/+5
2018-03-25Validate when building outputsGraham Christensen1-2/+2
2018-03-25docs: Build with a makefileGraham Christensen1-0/+69
2014-08-24Nixpkgs manual: Add a Nix expression to buildEelco Dolstra1-41/+0
2014-07-03Manual: html -> xhtmlEelco Dolstra1-3/+3
2009-07-10* Build a PDF of the manual.Eelco Dolstra1-2/+6
svn path=/nixpkgs/trunk/; revision=16316
2008-06-12* Manual outline.Eelco Dolstra1-1/+8
svn path=/nixpkgs/trunk/; revision=12057
2007-09-11* Release notes.Eelco Dolstra1-0/+3
* Linux 2.6.22.6. * w3m 0.5.2. svn path=/nixpkgs/trunk/; revision=9305
2006-10-06* Start of Nixpkgs 0.10 release notes.Eelco Dolstra1-5/+5
svn path=/nixpkgs/trunk/; revision=6676
2006-01-30* NEWS in DocBook.Eelco Dolstra1-0/+27
svn path=/nixpkgs/trunk/; revision=4627
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-08-06 03:10:50 +0000