2
0
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-12-18 11:44:07 +00:00
Commit Graph

50 Commits

Author SHA1 Message Date
Jan Tojnar
7497b4721c doc: Fix make in nix-shell
When running make manually, makeFlags will not be passed. Let’s just use an environment variable.
2021-06-05 13:25:48 +02:00
Alyssa Ross
503a772e02 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.
2021-02-12 08:59:27 -08:00
Jan Tojnar
ba11a96653
doc: Add staging workflow diagram 2020-12-09 05:26:55 +01:00
Graham Christensen
fa47df6174
doc: move parameters to an XML file 2019-07-04 09:16:06 -04:00
Graham Christensen
5a0696f6d0
xmlformat.conf: move to doc-support build 2019-07-04 09:10:14 -04:00
Graham Christensen
de58e706f9
docs: Get highlightjs from build symlink 2019-07-04 09:10:14 -04:00
Graham Christensen
35262ba6a7
docs: get XSL from build / symlink 2019-07-04 09:10:13 -04:00
Graham Christensen
e65c2c6672
docs: find docbook rng from doc-support 2019-07-04 09:10:13 -04:00
Graham Christensen
d11f5a9d15
docs: get version from doc-support build 2019-07-04 09:10:13 -04:00
Graham Christensen
cd6bf8aa00
docs: use a single nix-build for all the generate function docs 2019-07-04 09:07:47 -04:00
Vincent Ambo
0c99dac497 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.
2019-01-04 11:28:27 +01:00
Graham Christensen
5daee73ce4
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.
2018-10-05 11:20:46 -04:00
Frederik Rietdijk
1a6af9f88e
Merge pull request from volth/unused
[bot] treewide: remove unreferenced code
2018-07-20 21:06:32 +02:00
volth
87f5930c3f [bot]: remove unreferenced code 2018-07-20 18:48:37 +00:00
Matthew Bauer
76999cc40e 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
2018-07-18 23:25:20 -04:00
Daiderd Jordan
75601e10cb manual: make epub a build product on hydra () 2018-06-06 22:36:17 +02:00
Graham Christensen
ab1648bf0d
nixpkgs doc: add format Make target 2018-04-30 22:37:58 -04:00
Maximilian Bosch
9274ea3903
treewide: rename version attributes
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-28 14:23:53 +02:00
Graham Christensen
8dac5ce146
nixpkgs docs: syntax highlight 2018-03-26 21:44:24 -04:00
Graham Christensen
da17974541
Move the overridden CSS to overrides.css which can be applied on nixos.org 2018-03-26 14:45:00 -04:00
Graham Christensen
a80856cec5
nixpkgs docs: Use SVGs for callouts 2018-03-26 14:08:36 -04:00
Graham Christensen
30dd2d3feb
Validate when building outputs 2018-03-25 19:52:08 -04:00
Graham Christensen
7e25ff7106
docs: Build with a makefile 2018-03-25 19:52:07 -04:00
Graham Christensen
92d53362d4
Move all nixpkgs doc files in to the doc directory
This makes a makefile-driven developer workflow nicer.
2018-03-25 19:52:00 -04:00
Joachim Schiele
f41a3e7d7d
Emscripten 1.37.16 to 1.37.36 ()
* 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
2018-03-18 13:34:46 +01:00
zimbatm
adc5c9b83d
mkShell: add builder () 2017-12-20 23:42:07 +00:00
Leonid Onokhov
574528024d nixpkgs/manual: fix build with new pandoc 2017-12-20 14:22:05 +00:00
Eric Bailey
505508a813 Update BEAM docs
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-06-22 11:32:46 +02:00
Matthias Beyer
315e1a23c0 doc: Add rust documentation () 2017-03-20 20:41:37 +01:00
Vladimír Čunát
49b136377a
Merge : add a guide about vim plugins 2017-01-30 18:28:20 +01:00
Eelco Dolstra
ebdd896017 Nixpkgs manual: Fix epub generation
See 0804f67024.
2016-10-03 20:33:01 +02:00
Langston Barrett
a3bbb45e5c manual: add node to languages & frameworks
fixes 
2016-09-20 20:38:24 +00:00
Christine Koppelt
27e72d14af add epub for nixpkgs manual ( ) ()
* add epub for nixpkgs manual (  )

* change epub filename (interpreted as title & author by some epub readers)
2016-07-20 17:57:31 +02:00
Marc Weber
c3f56e912a Add nixpkgs documentation about how to create a derivation with Vim + plugins 2016-06-25 21:39:00 +02:00
John Ericson
f073df60d6 Replace ./../* with ../* in Nix expressions () 2016-06-22 10:39:50 +02:00
Vladimír Čunát
88a6ce17ef nixpkgs manual: fix : correct dash rendering 2016-05-27 10:40:49 +02:00
Eric Sagnes
96a4e1f80d nixpkgs manual: cleanup () 2016-05-22 10:05:37 +01:00
Domen Kožar
ccdda96c2f manual: use a better relaxng validation tool 2016-03-30 18:07:34 +01:00
Frederik Rietdijk
0ed331cf09 Documentation: fix usage of useChapters 2016-03-12 15:44:02 -05:00
Frederik Rietdijk
4c1525c1f8 Documentation: rewrite Python
- Rewrite current documentation
- Add introduction/tutorial
- Convert to markdown
2016-03-12 15:44:02 -05:00
Frederik Rietdijk
9310bd15de Revert "Documentation: rewrite Python docs" 2016-03-05 18:01:23 -05:00
Frederik Rietdijk
6af076730e Documentation: rewrite Python
- Rewrite current documentation
- Add introduction/tutorial
- Convert to markdown
2016-03-05 17:57:38 -05:00
Michel Kuhlmann
312494180d nixpkgs manual: add basic R documentation, fixes
also fixes 
2016-02-22 10:16:06 +01:00
Frederik Rietdijk
92179785b6 DOC: Overview of Nixpkgs/channels/Hydra/tests (close )
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.
2016-02-21 11:32:22 +01:00
Vladimír Čunát
3e4035695c nixpkgs manual: add idris docs generated from *.md
I also modified the nesting approach in haskell docs
to allow more uniform handling of markdown -> docbook conversions.
/cc .
2015-12-21 13:01:59 +01:00
Vladimír Čunát
ef21e5ee60 nixpkgs manual: split languages into separate files
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-12-19 16:08:00 +01:00
Peter Simons
a7840a9ce8 doc: generate haskell-users-guide.xml from Markdown input via Pandoc
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.
2015-09-30 17:24:28 +02:00
Peter Simons
46f59a3a14 doc/default.nix: fix Emacs syntax highlighting (no functional change) 2015-09-30 17:24:28 +02:00
Luca Bruno
36cd08e374 nixpkgs-manual: fix callouts 2015-06-30 11:04:46 +02:00
Eelco Dolstra
438b9c543d Nixpkgs manual: Add a Nix expression to build 2014-08-24 11:03:55 +02:00