summary refs log tree commit diff
path: root/doc/Makefile
Commit message (Collapse)AuthorAge
* nixos/doc: Synchronize the Markdown generator with NixpkgsJan Tojnar2021-06-18
| | | | Switch to CommonMark with our extensions.
* Merge pull request #125671 from SFrijters/doc-improve-make-cleanRyan Mulligan2021-06-12
|\ | | | | doc: Clean up generated media directory
| * doc: Clean up generated media directoryStefan Frijters2021-06-04
| | | | | | | | | | pandoc uses ./media to extract media files - add it to the list of directories that need to be removed by `make clean`.
* | doc: Use markdown syntax for xrefsJan Tojnar2021-06-07
| | | | | | | | | | | | Syntax is taken from MyST: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
* | doc: Build as CommonMarkJan Tojnar2021-06-07
|/ | | | | | | | 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.
* doc/README.md: initRobert Hensing2021-03-04
|
* doc: Add staging workflow diagramJan Tojnar2020-12-09
|
* doc: clean up makefileJan Tojnar2020-12-07
| | | | | 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.
* doc: fix MD_TARGETSMitsuhiro Nakamura2020-07-18
| | | | globstar (**) does not work in Makefile
* nixpkgs manual: fix build after pandoc(?) updateVladimír Čunát2020-03-02
| | | | | | | | 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
* doc: move parameters to an XML fileGraham Christensen2019-07-04
|
* xmlformat.conf: move to doc-support buildGraham Christensen2019-07-04
|
* docs: Get highlightjs from build symlinkGraham Christensen2019-07-04
|
* docs: get XSL from build / symlinkGraham Christensen2019-07-04
|
* docs: find docbook rng from doc-supportGraham Christensen2019-07-04
|
* docs: get version from doc-support buildGraham Christensen2019-07-04
|
* docs: use a single nix-build for all the generate function docsGraham Christensen2019-07-04
|
* manual: Make sure building doesn't need recursive nixJohn Ericson2019-03-24
| | | | | | $(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.
* doc: Include function doc generation in MakefileVincent Ambo2019-02-01
| | | | | | | | | | | | | 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
* manual: document ways of obtaining source hashesdanbst2019-01-11
| | | | ... and security nuances
* Generate links to function definitionsGraham Christensen2018-10-05
| | | | | | | | | | 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.
* nixpkgs: Start documenting library functions in XMLGraham Christensen2018-10-05
| | | | | | Covers assert functions and about half of the attrsets functions. Some internal consistency around IDs could be improved.
* nixpkgs docs: Rebuild manual-full if nested XML docs changeGraham Christensen2018-10-02
|
* doc: Adds xml fixing script. (see previous and next commits)Samuel Dionne-Riel2018-05-31
| | | | | | | | | | | | | | | | | | | | | | | 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
* nixpkgs doc: add format Make targetGraham Christensen2018-04-30
|
* treewide: rename version attributesMaximilian Bosch2018-04-28
| | | | | | | | | | | | | | | 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`.
* nixos docs: syntax highlightGraham Christensen2018-04-05
| | | | | | | | | - 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
* nixpkgs docs: syntax highlightGraham Christensen2018-03-26
|
* Move the overridden CSS to overrides.css which can be applied on nixos.orgGraham Christensen2018-03-26
|
* nixpkgs docs: Use SVGs for calloutsGraham Christensen2018-03-26
|
* Add 'make debug' to call xmloscopyGraham Christensen2018-03-25
|
* Move validate to top-level so it doesn't rebuild the outputs every timeGraham Christensen2018-03-25
|
* Validate when building outputsGraham Christensen2018-03-25
|
* docs: Build with a makefileGraham Christensen2018-03-25
|
* Nixpkgs manual: Add a Nix expression to buildEelco Dolstra2014-08-24
|
* Manual: html -> xhtmlEelco Dolstra2014-07-03
|
* * Build a PDF of the manual.Eelco Dolstra2009-07-10
| | | | svn path=/nixpkgs/trunk/; revision=16316
* * Manual outline.Eelco Dolstra2008-06-12
| | | | svn path=/nixpkgs/trunk/; revision=12057
* * Release notes.Eelco Dolstra2007-09-11
| | | | | | | * Linux 2.6.22.6. * w3m 0.5.2. svn path=/nixpkgs/trunk/; revision=9305
* * Start of Nixpkgs 0.10 release notes.Eelco Dolstra2006-10-06
| | | | svn path=/nixpkgs/trunk/; revision=6676
* * NEWS in DocBook.Eelco Dolstra2006-01-30
svn path=/nixpkgs/trunk/; revision=4627