about summary refs log tree commit diff
path: root/doc/default.nix
AgeCommit message (Collapse)AuthorFilesLines
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
2018-03-25Move all nixpkgs doc files in to the doc directoryGraham Christensen1-20/+20
This makes a makefile-driven developer workflow nicer.
2018-03-18Emscripten 1.37.16 to 1.37.36 (#37291)Joachim Schiele1-0/+4
* trying to build emscriptenPackages not all fail * reading the console.log it turns out python executable is not in place and that is why emconfigure didnt work * backup commit * much more targets are compiling now * added common revisioning * revision bump to 1.37.36 (not tested) * fixed xmllint * forcing unit testing, will implement the tests after i get home * json_c test working * added tests * tiny fixes * added documentation
2017-12-20mkShell: add builder (#30975)zimbatm1-0/+4
2017-12-20nixpkgs/manual: fix build with new pandocLeonid Onokhov1-3/+4
2017-06-22Update BEAM docsEric Bailey1-1/+1
Improve beam docs: * correct spelling * update per pandoc changes * capitalize titles * capitalize BEAM throughout and use "the BEAM" when referring to the virtual machine. * tweak grammar and phrasing * reformat build-tools-rebar3 section * add more links * re-wrap <para>s Also update <programlisting>s * normalize whitespace * don't double quote homepage * use $ in all shell snippets
2017-03-20doc: Add rust documentation (#23510)Matthias Beyer1-0/+4
2017-01-30Merge #16501: add a guide about vim pluginsVladimír Čunát1-0/+4
2016-10-03Nixpkgs manual: Fix epub generationEelco Dolstra1-2/+4
See 0804f67024f21a75a710e41423561cc0d3472e2f.
2016-09-20manual: add node to languages & frameworksLangston Barrett1-0/+4
fixes #18609
2016-07-20add epub for nixpkgs manual ( #15575 ) (#17053)Christine Koppelt1-10/+20
* add epub for nixpkgs manual ( #15575 ) * change epub filename (interpreted as title & author by some epub readers)
2016-06-25Add nixpkgs documentation about how to create a derivation with Vim + pluginsMarc Weber1-0/+4
2016-06-22Replace `./../*` with `../*` in Nix expressions (#16414)John Ericson1-2/+2
2016-05-27nixpkgs manual: fix #15735: correct dash renderingVladimír Čunát1-0/+1
2016-05-22nixpkgs manual: cleanup (#15611)Eric Sagnes1-3/+2
2016-03-30manual: use a better relaxng validation tool #4966Domen Kožar1-3/+3
2016-03-12Documentation: fix usage of useChaptersFrederik Rietdijk1-1/+1
2016-03-12Documentation: rewrite PythonFrederik Rietdijk1-0/+4
- Rewrite current documentation - Add introduction/tutorial - Convert to markdown
2016-03-05Revert "Documentation: rewrite Python docs"Frederik Rietdijk1-6/+0
2016-03-05Documentation: rewrite PythonFrederik Rietdijk1-0/+6
- Rewrite current documentation - Add introduction/tutorial - Convert to markdown
2016-02-22nixpkgs manual: add basic R documentation, fixes #13362Michel Kuhlmann1-1/+4
also fixes #13243
2016-02-21DOC: Overview of Nixpkgs/channels/Hydra/tests (close #11263)Frederik Rietdijk1-0/+5
What I missed when I began using Nix and NixOS was a clear overview of how packages, channels, Hydra, the master branch and updates to channels relate to each other. I've noticed I am not the only one, given the amount of times these questions pop up. For now I propose to include this in the Nixpkgs manual, since this seems to be the best fit. However, I think it would be good to include this in either a new manual, i.e., a user manual, or an 'official' tutorial.
2015-12-21nixpkgs manual: add idris docs generated from *.mdVladimír Čunát1-17/+29
I also modified the nesting approach in haskell docs to allow more uniform handling of markdown -> docbook conversions. /cc #11308.
2015-12-19nixpkgs manual: split languages into separate filesVladimír Čunát1-3/+7
There's no change in content except for amending the title of the section to mention "frameworks", as e.g. I don't consider Qt a language, and it's likely there will be more of similar cases in future. To be certain, I checked diff of the generated HTMLs.
2015-09-30doc: generate haskell-users-guide.xml from Markdown input via PandocPeter Simons1-1/+17
Editing Docbook is no fun, IMHO, so I'd rather store the Haskell documentation in Markdown format and use Pandoc to convert that into Docbook as part of the build process.
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-07-08 01:28:44 +0000