Commit graph

146 commits

Author SHA1 Message Date
Viktor Kronvall 07754e935a docs: add considerate as maintainer 2023-12-16 15:49:45 +09:00
Viktor Kronvall 6c82b1c9ce docs: use .xhtml for appendices 2023-12-16 15:46:42 +09:00
Viktor Kronvall 6fc71dc563 docs: add release-notes as appendix
The release notes used to be an appendix in the manual. After
converting to markdown that appendix got lost. This commit
reintroduces the release notes into the manual.
2023-12-16 15:46:00 +09:00
Phil Simpson 0e7cd64674
docs: fix nix-darwin module configuration example
The example is missing a `;` which causes this error when you attempt
a `darwin-rebuild switch`.

```
       error: syntax error, unexpected '=', expecting ';'

       at /Users/968713/.nixpkgs/darwin-configuration.nix:17:30:

           16|   }
           17|   home-manager.users.eve = { pkgs, ... }: {
             |                              ^
           18|     home.packages = [
```
2023-12-13 00:01:02 +01:00
Robert Helgesson fa91c109b0
docs: use relative paths to static resources
Fixes #4753
2023-12-09 13:20:54 +01:00
Robert Helgesson f10eb1b3ee
docs: apply nixfmt 2023-12-09 09:05:16 +01:00
Viktor Kronvall 613dbb35db docs: rename generated manual to index.xhtml
The `nixos-render-docs` tool outputs XHTML formatted content. In
order to convince browsers like `firefox` to treat the data as XHTML
the extension must be `.xhtml` and not `.html`.

Using the XHTML-formatted content as HTML is mainly an issue with
self-closing `<a />` tags.
2023-12-07 21:40:31 +09:00
Viktor Kronvall 0a71046493 docs: fix syntax highlighting
`document-highlighter` now outputs a `<code>` block inside the
pre-formatted `<pre>` tag. This changes the required CSS for
rendering code snippets. Moreover, this commit uses the highlightjs
as provided by the `document-highlighter` package instead of the
version packaged in `nmd`.
2023-12-07 21:31:50 +09:00
Viktor Kronvall b006bf1d74 docs: render DESCRIPTION and OPTIONS headings 2023-12-07 21:28:18 +09:00
Viktor Kronvall eff22a27e2 docs: replace console language with shell 2023-12-07 21:28:18 +09:00
Viktor Kronvall 67b797a377 docs: update nmd version
This update fixes the custom CSS to make the `$` character
non-selectable in highlighted code blocks.
2023-12-07 21:28:18 +09:00
Viktor Kronvall 5c2ef5243d docs: extend home-configuration.nix header
The previous version had a longer header before the options,
including a DESCRIPTION section and an header for the OPTIONS.
2023-12-07 21:28:18 +09:00
Viktor Kronvall be80122731 docs: include 3rd-party part 2023-12-07 21:28:18 +09:00
Viktor Kronvall b5a47bd700 docs: this is the home-manager manual 2023-12-07 21:28:18 +09:00
Viktor Kronvall 32063973cc docs: fix note blocks 2023-12-07 21:28:18 +09:00
Viktor Kronvall 2098c6fe91 docs: no justification in home-manager manpage
The `man home-configuration.nix` is configured to left
align the text similar to `man configuration.nix`. This
commit updates the `man home-manager` page to be consitent
with the two manpages mentioned above.
2023-12-07 21:28:18 +09:00
Viktor Kronvall 8dae2041ef docs: use nixos-render-docs
This commit removes the `home-manager-render-docs` package in favor
of upstream `nixos-render-docs` where the manpage generator has been
updated to take a `--header` and a `--footer` flag specifying static
content around the content derived from the options.json file.
2023-12-07 21:28:16 +09:00
Viktor Kronvall e4d290396c docs: update manual to refer to 23.11 2023-12-07 21:27:38 +09:00
Viktor Kronvall f48a0062df docs: update paths to make manual tests pass 2023-12-07 21:27:38 +09:00
Viktor Kronvall 0dcb767676 docs: add htmlOpenTool to manual
This commit extracts the htmlOpenTool from `nmd` into a module
in the home-manager docs directory. This is done to provide feature
parity with the documentation generated using the docbook .xml files.
2023-12-07 21:27:38 +09:00
Viktor Kronvall 728423e6f4 docs: add home-manager manpage 2023-12-07 21:27:38 +09:00
Viktor Kronvall 80ac72bf03 docs: render without deprecated optionsDocBook
The `optionsDocBook` function is deprecated in nixpkgs since
nixos-23.11. This commit updates the manual and manpages to
use commonmark formatted documentation instead of the deprecated
docbook format.
2023-12-07 21:27:38 +09:00
Robert Helgesson e1f3b36ab0
home-manager: set unstable release to 24.05 2023-11-24 09:25:42 +01:00
Robert Helgesson aeb2232d7a
home-manager: set stable release to 23.11 2023-11-24 09:23:25 +01:00
Robert Helgesson ae631b0b20
docs: fix option name
Fixes #4589
2023-10-20 23:56:29 +02:00
Artturin f6bb5c2973
docs: add stateVersion to the NixOS/nix-darwin example
This is necessary, without this a new user gets

```
error: The option `home-manager.users.X.home.stateVersion' is used but not defined.
```
2023-10-17 07:58:51 +02:00
pacien 6bba64781e
password-store-sync: remove module
The module `services.git-sync` (introduced two years after) provides
the same functionality, but in a more general and reliable way.
2023-10-10 14:28:09 +02:00
Emily c707d4f552 docs: hide _module.* from NixOS/nix-darwin docs
These are already documented in the system-level manuals and have no
particular relevance to the `home-manager.*` options.
2023-07-19 21:44:06 +01:00
Emily 8c350c2069 docs: update for Markdown migration 2023-07-17 18:49:09 +01:00
Emily 7398af11b8 docs: clean up after Markdown migration 2023-07-17 18:49:09 +01:00
Emily 59b933653a docs: use nixosOptionsDoc
Output is mostly unchanged aside from some minor typographical and
formatting changes, along with better source links.

We temporarily export `options.docBookForMigration` to allow
`nix-doc-munge` to check its conversions.
2023-07-17 16:49:35 +01:00
Emily 23ad3d2b53 version: add isReleaseBranch 2023-07-17 16:49:32 +01:00
Norbert Melzer 47c2adc6b3
docs: update link to allowed users setting (#4176)
1. The option has been renamed in NixOS about a year ago.
2. The link into the manual describing that option has been
   fixed.
2023-06-28 11:41:08 +02:00
Robert Helgesson 172d46d4b2
docs: bump nmd
Removes the need to apply `fix-man-options-duplication.patch`. See,
e.g., https://github.com/NixOS/nixpkgs/pull/166509.
2023-06-24 19:28:15 +02:00
Robert Helgesson 28b6c3670c
docs: update nmd
With improved conversion of Markdown list items.
2023-06-24 13:18:38 +02:00
Robert Helgesson 29872a1c8f
docs: update nmd
Mainly to work around recent changes in Nixpkgs with respect to
`_module.args`.
2023-06-24 11:52:37 +02:00
Naïm Favier 6c78ba7932
docs/contributing: link to NMT's bash-lib (#4125) 2023-06-22 16:35:33 +02:00
Midnight Veil a10aa82e8a
docs: Document osConfig module argument (#4103)
As mentioned https://github.com/nix-community/home-manager/issues/393#issuecomment-1259996423.

Otherwise only documented in source code, which isn't very findable.
2023-06-19 11:37:28 +02:00
Robert Helgesson 28614ed7a1
lib: add functions to create DAGs from lists 2023-06-05 23:08:30 +02:00
Naïm Favier 96078e4a93
Fix release notes (#4044) 2023-06-01 00:44:06 +02:00
Emily 53ccbe0170
fish: use babelfish for hm-session-vars.sh (#4012)
* home-environment: add `home.sessionVariablesPackage`

Allow the `hm-session-vars.sh` derivation to be referenced from other
modules, e.g. to translate it to fish with babelfish at build time.

* fish: use babelfish for `hm-session-vars.sh`

Translate `hm-session-vars.sh` to fish at system build time,
significantly decreasing shell startup time.

Based on https://github.com/NixOS/nixpkgs/pull/108947 by @kevingriffin.
2023-06-01 00:01:27 +02:00
Robert Helgesson f1490b8caf
Switch current unstable version to 23.11 2023-05-31 19:11:30 +02:00
Robert Helgesson 33ccc5c285
Switch stable branch to release-23.05 2023-05-31 19:11:29 +02:00
Cynthia Fox 59659243cd
PR_TEMPLATE: Note nix3 test method in checklist (#3972)
* PR_TEMPLATE: Note nix3 test method in checklist

Allows for running with the `nixpkgs` from the lock file, as well as
using a more familiar interface for users of the experimental CLI, which
would've avoided me opening #3971.

Also updates the corresponding note in `docs/contributing.adoc` to have
the correct invocation path.

* PR_TEMPLATE: `the experimental CLI` -> `Flakes`
2023-05-17 12:59:35 +02:00
Naïm Favier e4272987f7
Drop CODEOWNERS 2023-05-14 12:46:21 +02:00
Jan Tojnar ea29b1a8d1
docs: Add GVariant cross-references 2023-05-07 12:25:32 +02:00
Jan Tojnar 13d666dd68
docs: Mention GVariant format strings 2023-05-07 12:25:31 +02:00
Jan Tojnar a0ddb8af40
docs: Mention GVariant auto-coercion at the top 2023-05-07 12:25:30 +02:00
Jan Tojnar cfa5c2869b
docs: GVariant dictionaries are already supported
The support for dictionaries were introduced in 864ff685fe.
2023-05-07 12:25:29 +02:00
Jan Tojnar 81d5b220cd
docs: Fix broken GVariant docs link 2023-05-07 12:25:28 +02:00